v3: every doc opens with the role, then the mechanism, then the details — the docs were written bottom-up: what a thing does first ("Declares the three contexts WSProvider fills…"), details that only make sense once its purpose is known next, and the reason it exists last ("…so that a feed doesn't re-render"), so a reader had nothing to hang the first sentences on. The README's rule caused it, since a module doc "opened with what the module does"; it now opens with the module's role in the app, and the value-side phrasing of a type ("Returned to Y by X") comes once the role is said, with WSContext as the before and after. WSContext.ts is rewritten that way throughout, and so are the docs elsewhere that buried their purpose in a trailing "so that" (the migrations, og, image-proxy, public-address, useFading, useFeedCache, the drafts), opened on a generic verb that hid it ("Holds", "Declares", "Loads", "Defines", "Types": the contexts and providers, the shared types, the models, the hooks), or were label fragments ("The page of a dump…", "A row of tabs."). A function whose verb is its action ("Stores session"), a props or result type, and a protocol message ("Sent by X when Y") already say their role and are left as they are. Only comments changed, and the catalogs only move their references; deno fmt, deno lint and doc:lint are clean.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
/**
|
||||
* The modal that posts a dump from a link or a file, then offers to add it to
|
||||
* the poster's playlists. Every "new dump" button opens it.
|
||||
* Renders the modal that posts a dump from a link or a file, then offers to add
|
||||
* it to the poster's playlists. Every "new dump" button opens it.
|
||||
*
|
||||
* @module
|
||||
*/
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
/**
|
||||
* The panels of the dump creation modal, and the indicator showing which one
|
||||
* is open.
|
||||
* Shows which panel of the dump creation modal is open, and declares the panels
|
||||
* in the order they are walked.
|
||||
*
|
||||
* @module
|
||||
*/
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
/**
|
||||
* The title field of the dump creation modal, read-only until the poster
|
||||
* chooses to edit it.
|
||||
* Renders the title field of the dump creation modal, read-only until the
|
||||
* poster chooses to edit it.
|
||||
*
|
||||
* @module
|
||||
*/
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
/**
|
||||
* The tab bar of the index page, with the category switcher before the tabs.
|
||||
* Renders the tab bar of the index page, with the category switcher before the
|
||||
* tabs.
|
||||
*
|
||||
* @module
|
||||
*/
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/**
|
||||
* A row of tabs.
|
||||
* Renders the row of tabs of the index, profile and search pages.
|
||||
*
|
||||
* @module
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user