Skip to content

docs: fix inaccurate non-terminal naming rules in GBNF README - #26489

Open
JingliangGao wants to merge 1 commit into
ggml-org:masterfrom
JingliangGao:fix-grammar-readme-clean
Open

docs: fix inaccurate non-terminal naming rules in GBNF README#26489
JingliangGao wants to merge 1 commit into
ggml-org:masterfrom
JingliangGao:fix-grammar-readme-clean

Conversation

@JingliangGao

Copy link
Copy Markdown

Fixes #7720

The README section on Non-Terminals claimed that rule names are required to be dashed lowercase words, but the grammar examples (e.g. c.gbnf) freely use camelCase names like dataType, relationOperator, argList, etc.

This PR updates the description to reflect actual GBNF behavior - non-terminals can contain letters, digits, hyphens, and underscores, and camelCase names work fine.

No code changes; documentation only.

…rg#7720)

The README claimed non-terminals are required to be dashed lowercase
words, but grammar examples (e.g. c.gbnf) freely use camelCase names
like dataType, relationOperator, argList, etc. Update the description
to reflect actual behavior.
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Aug 3, 2026
@ggml-gh-bot

ggml-gh-bot Bot commented Aug 3, 2026

Copy link
Copy Markdown

Hi @JingliangGao, thanks for your contribution!

Per our contribution guidelines, the automated PR checker found the following issue(s) that need your attention:

  • PR Template not respected: Please respect the template when creating a new pull request. Make sure to fill out all required sections.

Please note that maintainers reserve the right to make final decisions on PRs. If you believe there is a mistake, please comment below.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Bug: Grammar readme seems incorrect

1 participant