docs: tags on silent rules

[phi-go]

Tags do not work on silent rules see: pest-parser/pest#1035
This adds some documentation for that.

I also added a warning label for the grammar-extras feature, though, not certain this is supported.

Summary by CodeRabbit

• Documentation
  • Enhanced clarity on the usage of tags within grammar rules.
  • Added warnings about enabling the "grammar-extras" feature for proper functionality.
  • Included examples illustrating the impact of silent rules on tagging.

[coderabbitai]

Walkthrough

The changes enhance the documentation regarding the usage of tags within grammar rules. Key clarifications include the necessity for tagged parts of rules to be non-silent, warnings about enabling the "grammar-extras" feature, and examples illustrating the impact of silent rules on tagging. These updates aim to improve user understanding of tag interactions in grammar definitions.

Changes

Files	Change Summary
src/grammars/syntax.md	Added clarifications on tag usage, silent rules, and the "grammar-extras" feature with examples and warnings.

Sequence Diagram(s)

(No sequence diagrams generated as the changes do not warrant visual representation of control flow.)

Poem

🐰 In the land of syntax, where tags do play,
A rabbit hops lightly, guiding the way.
With rules now more clear, and warnings in sight,
We dance through the grammar, all merry and bright!
So let’s tag with delight, let our voices be heard,
In the world of the code, every tag is a word! 🌟

Tip

We have updated our review workflow to use the Anthropic's Claude family of models. Please share any feedback in the discussion post on our Discord.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ba1a538 and e63892f.

Files selected for processing (1)

• src/grammars/syntax.md (1 hunks)

Additional context used

LanguageTool

src/grammars/syntax.md

[uncategorized] ~445-~445: You might be missing the article “the” here.
Context: ...II } ``` [!WARNING] You need to enable "grammar-extras" feature to use this func...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

Additional comments not posted (4)

src/grammars/syntax.md (4)

429-430: LGTM!

The note provides important information about the limitation of using tags with silent rules.

---

432-435: LGTM!

The example clearly illustrates the limitation of using tags with silent rules.

---

437-442: LGTM!

The information and example provide additional context about the limitation of using tags with built-in rules.

---

444-445: LGTM!

The warning provides important information about the configuration required to use the tags functionality.

Tools

LanguageTool

[uncategorized] ~445-~445: You might be missing the article “the” here.
Context: ...II } ``` [!WARNING] You need to enable "grammar-extras" feature to use this func...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

[tomtau]

thanks!