Commit Graph
4 Commits
Author SHA1 Message Date
dckc 018339689b docs-files-api: a script that prints usage keeps its manual in HELP
Refines the program-script exception: when the script prints its usage,
the manual is a HELP string constant under a one-line @file (JS has no
docstrings), not a comment copied into code or re-read from source.

Generated-by: Claude Opus 5.5
2026-10-07 09:44:26 -05:00
dckc da4e709ef4 docs-files-api: program scripts' @file is their manual
The exception: a script run directly (shebang or import.meta.main) puts
its purpose, usage synopsis, arguments, and outputs in @file. Readers
open a script to learn how to run it; its main has no call sites for
JSDoc to show at.

Generated-by: Claude Opus 5.5
2026-10-07 09:37:19 -05:00
dckc 7a9b25538b docs-files-api: API docs are JSDoc, not // comments
What a declaration is or does goes in /** */ on it (IDEs show it at call
sites and on hover); `//` is for the why of a line inside a body. The
description gains the trigger: a `//` comment explaining a declaration.

Generated-by: Claude Opus 5.5
2026-10-07 09:31:04 -05:00
dckc 7be7cfc767 Add docs-files-api skill 2026-10-06 21:51:07 -05:00