rust-lang / rust-lang/reference
Explicitly state grammar ambiguity
Open
Nobody has claimed this yet.
A-grammar
- Dominant language
- Rust
- Stars
- 1.6k
- Forks
- 607
- PR merge metrics
- PR metrics pending
Description
The grammar is ambiguous in the expressions chapter since we describe the grammar as a flat list of expressions and not the full precedence based grammar that becomes unreadable. This is okay, but we don't actually tell the reader that we are doing this and we really need to.
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 in the expressions chapter of the Rust Reference and read the grammar discussion alongside the surrounding explanatory text. Add an explicit note that the shown grammar is a flat, illustrative list rather than the full precedence-based grammar; the work is done when readers are clearly told why the simplified presentation is used.
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
- Mostly clear
- Newbie friendliness
- 55/100