rust-lang / rust-lang/reference

Grammar "with the exception of"s are ambiguous

Open
#1,973 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-grammar Formatting
Dominant language
Rust
Stars
1.6k
Forks
607
PR merge metrics
PR metrics pending

Description

I'm writing a grammar for rust-lang/rust#136889 and got the following result:

Image

I took this to mean:

with the exception of:

  • FRONTMATTER_FENCE
  • CHAR

and thought I had a bug in my grammar and played around a bit before I realized the intention is:

CHAR
with the exception of:

  • FRONTMATTER_FENCE

I feel like putting the exception warning below the grammar item would remove this ambiguity.

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.

Research direction

Start from the grammar documentation wording shown in the issue and locate the section describing “with the exception of” syntax. Compare the rendered ordering with the intended CHAR and FRONTMATTER_FENCE interpretation; done when the exception placement is unambiguous to readers.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.