rust-lang / rust-lang/reference
Macro-by-Examples' "Metavariables" section should link to the "Follow-set Ambiguity Restriction" section
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 1.6k
- Forks
- 607
- PR merge metrics
- PR metrics pending
Description
Currently, someone using the reference to figure out why a macro-by-example isn't working will probably look at the Metavariables section to see how their syntax usage matches with the language definitions provided. However, the syntax of metavariables is only partially defined by the language's syntax; it is additionally constrained by the Follow-set Ambiguity Restrictions.
Could a link be placed prominently in the "Metavariables" section to the "Follow-set Ambiguity Restrictions" section, so that people are less likely to miss this?
(I can submit a PR for this, if it is judged to be worthwhile.)
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 by reading the linked Metavariables and Follow-set Ambiguity Restrictions sections in the Rust Reference. Add a prominent link from the former to the latter, then verify that the rendered documentation link points to the correct section.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 68/100