Fix grammar README: Update non-terminal naming rules #17330
+1
−1
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
The documentation stated that non-terminal symbols must be 'dashed lowercase words' like 'move' or 'check-mate', but the actual parser supports much more flexibility. Rule names can include: - Uppercase letters (e.g., dataType, UPPER-CASE) - Numbers (e.g., rule123) - Both dashes and underscores This was discovered when c.gbnf used 'dataType' with an uppercase letter, which works correctly despite the documentation saying otherwise. Updated the docs to accurately describe the parser's capabilities rather than restrict them. Fixes ggml-org#7720 Signed-off-by: Samaresh Kumar Singh <ssam3003@gmail.com>
Author
|
I was writing my own grammar and kept getting confused by the documentation saying I had to use lowercase-dashed names, but then I saw the c.gbnf example using 'dataType'. Took me a while to realize the parser is actually way more flexible than the docs claimed. Hope this update helps others avoid the same confusion |
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.
I noticed the grammar README documentation was outdated. It stated that rule names must be 'dashed lowercase words', but when I looked at the examples like
c.gbnf, I saw it usesdataTypewith an uppercase letter.After checking the discussion in #7720, it's clear the parser actually supports much more flexibility than the docs suggested:
This PR updates the documentation to accurately reflect what the parser actually supports. The examples work fine - the docs just needed updating to match reality.
Changes:
This should help people understand they have more flexibility when naming their grammar rules.
Fixes #7720