Repository navigation
docs: clarify comments for readers new to the codebase - #3
Merged
Merged
Conversation
Rewrite JSDoc that only made sense with knowledge of the earlier slice-based design (parser, memoize, many, run, label, grammar, choice), fix the wrong associativity note on chainLeft and the circular one on inner, and drop a stale output-format comment in grammar.test.ts. README.md and doc/api are regenerated from the JSDoc. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…ents # Conflicts: # doc/api/combinators.md # src/core/run.ts
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
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.
Rewrites code comments that only made sense to someone who knew the earlier slice-based design.
parser,memoize,many,run,label,grammar,choice: JSDoc now describes the current offset-based behaviour (e.g. "readsinputfromindexand never slices it" → what a parser receives and returns)chainLeft: the "(right-to-left for same precedence)" note was wrong; it now says1-2-3is evaluated as(1-2)-3inner: replaces the circular "like inner of braced" descriptiongrammar.test.ts: drops a stale// [6, '']comment from the old output formatREADME.mdanddoc/api/regenerated from the JSDocNo code changes. Tests and lint pass.
🤖 Generated with Claude Code