docs: document the public API as TSDoc (generated from type declarations) - #4
Open
lucas-tortora wants to merge 5 commits into
Open
docs: document the public API as TSDoc (generated from type declarations)#4lucas-tortora wants to merge 5 commits into
lucas-tortora wants to merge 5 commits into
Conversation
…tions Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
lucas-tortora
force-pushed
the
chore/ts-doc
branch
from
August 5, 2026 20:17
c2cdf98 to
6923331
Compare
Points README ## API to docs.pears.com instead of duplicating the generated reference inline. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Reflows comment text added by the earlier TSDoc commit so no line exceeds 100 columns, matching the convention settled on in bare-fs #44. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Switches the README API link text from "full API reference" to the `<module> reference` form, matching the pattern settled on in bare-fs #44 and merged in bare-ws. Long module names use a reference-style link to stay within 100 columns. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Document the public API as TSDoc
Adds TSDoc —
@param/@returns/@throwstags plus member descriptions — to the shipped.d.ts. Everything is derived from the existing type declarations and this module's ownindex.js/libsource.The README's
## APIsection links to the generated reference instead of inlining it, per the pattern settled on in bare-fs #44. Comments are wrapped to keep every line within 100 columns.Reviewed against source; happy to adjust wording, scope, or split as you prefer.
🤖 Generated with Claude Code