Give examples of each metavariable value in macro declarations

Open Beginner friendly
#1,617 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
rust
Domain
documentation

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.

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.

Dominant language
Rust
Stars
1.6k
Forks
607
Avg merge
1d 1h
Merged PRs (30d)
12

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from rust-lang/reference

All issues in rust-lang/reference

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.