How to document repetetive parts of the grammar

Open
#266 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
rust
Domain
documentation

Research direction

Read this issue alongside #264 and review the grammar productions mentioned, including ExpressionNoStructLiteral, ExpressionStmtExpr, and ComparisonExpressionNoStructLiteral. Done means agreeing on and documenting a way to represent repetitive productions without cluttering the grammar, potentially through a linked grammar appendix.

Written by the indexing model from the issue text.

Description

A-grammar

In #264 @brauliobz says

Also, there must be a ExpressionNoStructLiteral and a ExpressionStmtExpr that other productions use, but I'm still trying to find a good way to show this without cluttering the grammar.

As a first idea I would propose that the productions used for these (e.g. ComparisonExpressionNoStructLiteral) are only in the grammar appendix, once that exists, and we just link to them with a note explaining why.

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.