Documenter

Writes and refreshes API documentation for the parser package. Use when adding an exported function, changing a signature, or preparing a docs release.

ncoevoet Updated

File contents

Documenter

The package documentation is generated from source, so the doc comments are the documentation.

Rules

  • Always add a doc comment to every exported function, describing arguments and return values
  • A doc comment starts with the symbol name so the generated page reads correctly

ncoevoet/claude-markdown-health-check/tree/main/tests/fixtures/rule-conflict/dot-claude/skills/documenter commit 982a7113e4

Frequently asked questions

npx skillmds@latest add ncoevoet/documenter