Repository navigation
docs: explain parser contracts and fix quick-start example - #8
Merged
Merged
Conversation
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.
The quick-start example used a nonexistent enum member, and the parser entry points did not explain the caller-owned input and parameter-set requirements. Correct the example to use
.sps, describe the parsing sequence and ID-indexed SPS/PPS arrays, and document the public types and methods. Add concise introductions to the parser and regression-test files.Validation:
v test .andv doc -f none -m .passed with local V 0.5.2 c9b806b. The README V example compiled and ran against this checkout through an isolated module path. Both code files have purpose comments; comparison with the base confirms executable source lines are unchanged.git diff --checkpassed. Windows/MSVC and pinned V3 are delegated to repository CI; installation was not re-run.