rust-lang / rust-lang/reference
Give examples of each metavariable value in macro declarations
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 1.6k
- Forks
- 607
- PR merge metrics
- PR metrics pending
Description
https://doc.rust-lang.org/reference/macros-by-example.html#metavariables
I think the above section would be way clearer if each metavariable bullet item contained a short concrete example or two.
I know you can click through to the grammar definition, but sometimes I just need a hint, without scrutinizing the entire production.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked Rust Reference metavariables section in the macro-by-example documentation and review each metavariable bullet. Add one or two short concrete examples to each item, then confirm that every bullet is clearer without requiring readers to inspect the grammar definition.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 68/100