jsdocs

1---2name: jsdocs3description: Public API JSDoc. Use when authoring or reviewing Effect API documentation, refining a module's documentation, or fixing documentation related diagnostics.4---5 6## Workflow7 81. Inspect the declaration, implementation, nearby JSDoc, tests, and call sites.92. Select every applicable branch and load its reference before editing:10   - tags, modules, or links: [declarations.md](declarations.md);11   - categories: [categories.md](categories.md);12   - examples: [examples.md](examples.md).133. Make a focused API fix or module refinement. Preserve verified facts and14   valuable examples rather than rewriting mechanically.154. For module refinement or APIs with close alternatives, audit `@see` links16   and inspect implementation and tests for concrete `**Gotchas**`.175. Run `pnpm jsdocs --check` and every applicable root validation command.18 19`@internal` declarations and default exports are outside public JSDoc20authoring. Checked files do not support exported enums or empty export21declarations.22 23Public declarations use a multiline block with one self-contained practical24description paragraph. Start functions and methods with a present-tense action;25match nearby noun-family phrasing for values. Optional non-empty sections appear26once in this order: `**When to use**`, `**Details**`, `**Gotchas**`. Separate27descriptions, sections, examples, and tags with one blank line. `**When to28use**` states a positive use case distinct from the description; reserve29`**Gotchas**` for concrete caveats and failure modes.30 31The task is complete when every changed public declaration satisfies each32applicable reference, the checker passes, runnable examples pass their targeted33doctest, and all other applicable root checks pass or are reported as not run.34