Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the documentation to reflect changes in the CustomLexer and Parser APIs, specifically the removal of the context.Context parameter from state interface methods in favor of passing context through dedicated context objects (CustomLexerContext and ParserContext).
Changes:
- Updated interface method signatures to remove
context.Contextparameters fromLexState.Run()andParseState.Run() - Revised documentation to clarify that context objects are passed to state methods
- Reorganized documentation sections, moving lexer invocation examples before
CustomLexerdetails
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| parser.go | Removed ctx parameter name from ParseState.Run() interface method |
| lexparse.go | Updated function comment to mention concurrent token feeding |
| custom.go | Removed ctx parameter name from LexState.Run() interface method |
| README.md | Updated all documentation and code examples to reflect new API signatures and context object usage |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: Ian Lewis <ian@ianlewis.org>
3f80c46 to
96723fa
Compare
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.
Description:
Update documentation to reflect the new
CustomLexerandParserAPIs.Related Issues:
Fixes #173
Checklist:
CONTRIBUTING.mddocumentation.CHANGELOG.mdif applicable.