Macro-by-Examples' "Metavariables" section should link to the "Follow-set Ambiguity Restriction" section

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

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
rust
Domain
documentation

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.

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.)

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.