Merged
Conversation
This updates the shebang description, primarily to add a grammar for it. It also reworks the rules so the introduction explains what this section is talking about, and placing specific behaviors in individual rules.
Collaborator
|
This PR was rebased onto a different master commit. Here's a range-diff highlighting what actually changed. Rebasing is a normal part of keeping PRs up to date, so no action is needed—this note is just to help reviewers. |
The shebang section was rewritten to add a grammar and to restructure the rules. Let's improve some things editorially. In this commit, we reorder the syntax explanation so that the basic description (start and end) comes before the exception (the `#![` disambiguation). We replace the awkward "continues to and including" with "extends through", convert the purpose clause into a parenthetical, remove a stray blank line between the rule identifier and the grammar block, and use the existing `[shebang]` link definition so that the term links to Wikipedia.
traviscross
approved these changes
Mar 1, 2026
Contributor
|
Looks good; thanks. |
traviscross
added a commit
that referenced
this pull request
Mar 4, 2026
The `r[frontmatter.document]` rule said "Frontmatter may only be preceded by a shebang and whitespace", where the "and" could be misread as requiring both a shebang and whitespace rather than listing the set of things allowed to precede frontmatter. Since we merged the shebang prose revision (#2192), the shebang position rule now reads as a positive statement of where the shebang may appear. Let's follow the same pattern here: state positively where frontmatter may appear rather than leaning on "only" and a negative constraint. In this commit, we rewrite the rule as "Frontmatter may appear at the start of the file or after a shebang, in either case optionally preceded by whitespace." This resolves the ambiguity and parallels the shebang position rule's structure.
traviscross
added a commit
that referenced
this pull request
Mar 4, 2026
The `r[frontmatter.document]` rule said "Frontmatter may only be preceded by a shebang and whitespace", where the "and" could be misread as requiring both a shebang and whitespace rather than listing the set of things allowed to precede frontmatter. Since we merged the shebang prose revision (#2192), the shebang position rule now reads as a positive statement of where the shebang may appear. Let's follow the same pattern here: state positively where frontmatter may appear rather than leaning on "only" and a negative constraint. In this commit, we rewrite the rule as "Frontmatter may appear at the start of the file or after a shebang, in either case optionally preceded by whitespace." This resolves the ambiguity and parallels the shebang position rule's structure.
traviscross
added a commit
that referenced
this pull request
Mar 4, 2026
The `r[frontmatter.document]` rule said "Frontmatter may only be preceded by a shebang and whitespace", where the "and" could be misread as requiring both a shebang and whitespace rather than listing the set of things allowed to precede frontmatter. Since we merged the shebang prose revision (#2192), the shebang position rule now reads as a positive statement of where the shebang may appear. Let's follow the same pattern here: state positively where frontmatter may appear rather than leaning on "only" and a negative constraint. In this commit, we rewrite the rule as "Frontmatter may appear at the start of the file or after a shebang, in either case optionally preceded by whitespace." This resolves the ambiguity and parallels the shebang position rule's structure.
traviscross
added a commit
that referenced
this pull request
Mar 4, 2026
The `frontmatter.document` rule said "Frontmatter may only be preceded by a shebang and whitespace", where the "and" could be misread as requiring both a shebang and whitespace rather than listing the set of things allowed to precede frontmatter. Since we merged the shebang prose revision (#2192), the shebang position rule now reads as a positive statement of where the shebang may appear. Let's follow the same pattern here: state positively where frontmatter may appear rather than leaning on "only" and a negative constraint. We'll also rename the rule identifier to `frontmatter.position` in keeping with our conventions.
traviscross
added a commit
that referenced
this pull request
Mar 4, 2026
The `frontmatter.document` rule said "Frontmatter may only be preceded by a shebang and whitespace", where the "and" could be misread as requiring both a shebang and whitespace rather than listing the set of things allowed to precede frontmatter. Since we merged the shebang prose revision (#2192), the shebang position rule now reads as a positive statement of where the shebang may appear. Let's follow the same pattern here: state positively where frontmatter may appear rather than leaning on "only" and a negative constraint. We'll also rename the rule identifier to `frontmatter.position` in keeping with our conventions.
traviscross
added a commit
that referenced
this pull request
Mar 4, 2026
In #2192, we extended our documentation about shebangs but kept it in Input Format under a section on shebang removal. But really, this section is mostly now about documenting what a shebang is, for our purposes. Let's separate this out into a new subchapter. We'll keep the rule about shebang removal in Input Format; it can link to Shebang for a description of what a shebang is, its grammar, etc. This follows the pattern that we'll similarly be using for frontmatter.
JonathanBrouwer
added a commit
to JonathanBrouwer/rust
that referenced
this pull request
Mar 9, 2026
Update books ## rust-embedded/book 4 commits in 99d0341ff4e06757490af8fceee790c4ede50bc0..e88aa4403b4bf2071c8df9509160477e40179099 2026-02-28 20:13:44 UTC to 2026-02-28 20:07:25 UTC - Clarify that a mini usb cable is used on the STM32F3DISCOVERY (rust-embedded/book#381) - Update outdated qemu documentation (rust-embedded/book#403) - Add TRACE32 to Debuggers section (rust-embedded/book#406) - Add a link to Rust for Zephyr (rust-embedded/book#407) ## rust-lang/nomicon 4 commits in b8f254a991b8b7e8f704527f0d4f343a4697dfa9..cc6a6bae8c3bfa389974e533c54694662c1a9de6 2026-02-27 23:27:18 UTC to 2026-02-26 22:57:03 UTC - Fix `Vec::push_all` ptr code in exception-safety (rust-lang/nomicon#418) - Clarify parameter and argument compatibility (rust-lang/nomicon#516) - Improve grammar in Variance section (rust-lang/nomicon#515) - Explicit `extern "C"` ABI for FFI (rust-lang/nomicon#520) ## rust-lang/reference 7 commits in 50a1075e879be75aeec436252c84eef0fad489f4..c49e89cc8c7c2c43ca625a8d5b7ad9a53a9ce978 2026-03-04 15:39:00 UTC to 2026-03-01 06:34:18 UTC - Resolve grammar rules in link reference definitions (rust-lang/reference#2198) - Support non-ASCII Unicode in grammar rule names (rust-lang/reference#2196) - Fix grammar for block comments (rust-lang/reference#2191) - Fix an EN grammar error & add an item to place expr context list (rust-lang/reference#2189) - Align attribute template with applied conventions (rust-lang/reference#2194) - Update shebang (rust-lang/reference#2192) - Remove RESERVED_NUMBER (rust-lang/reference#2193)
matthiaskrgr
added a commit
to matthiaskrgr/rust
that referenced
this pull request
Mar 9, 2026
Update books ## rust-embedded/book 4 commits in 99d0341ff4e06757490af8fceee790c4ede50bc0..e88aa4403b4bf2071c8df9509160477e40179099 2026-02-28 20:13:44 UTC to 2026-02-28 20:07:25 UTC - Clarify that a mini usb cable is used on the STM32F3DISCOVERY (rust-embedded/book#381) - Update outdated qemu documentation (rust-embedded/book#403) - Add TRACE32 to Debuggers section (rust-embedded/book#406) - Add a link to Rust for Zephyr (rust-embedded/book#407) ## rust-lang/nomicon 4 commits in b8f254a991b8b7e8f704527f0d4f343a4697dfa9..cc6a6bae8c3bfa389974e533c54694662c1a9de6 2026-02-27 23:27:18 UTC to 2026-02-26 22:57:03 UTC - Fix `Vec::push_all` ptr code in exception-safety (rust-lang/nomicon#418) - Clarify parameter and argument compatibility (rust-lang/nomicon#516) - Improve grammar in Variance section (rust-lang/nomicon#515) - Explicit `extern "C"` ABI for FFI (rust-lang/nomicon#520) ## rust-lang/reference 7 commits in 50a1075e879be75aeec436252c84eef0fad489f4..c49e89cc8c7c2c43ca625a8d5b7ad9a53a9ce978 2026-03-04 15:39:00 UTC to 2026-03-01 06:34:18 UTC - Resolve grammar rules in link reference definitions (rust-lang/reference#2198) - Support non-ASCII Unicode in grammar rule names (rust-lang/reference#2196) - Fix grammar for block comments (rust-lang/reference#2191) - Fix an EN grammar error & add an item to place expr context list (rust-lang/reference#2189) - Align attribute template with applied conventions (rust-lang/reference#2194) - Update shebang (rust-lang/reference#2192) - Remove RESERVED_NUMBER (rust-lang/reference#2193)
matthiaskrgr
added a commit
to matthiaskrgr/rust
that referenced
this pull request
Mar 9, 2026
Update books ## rust-embedded/book 4 commits in 99d0341ff4e06757490af8fceee790c4ede50bc0..e88aa4403b4bf2071c8df9509160477e40179099 2026-02-28 20:13:44 UTC to 2026-02-28 20:07:25 UTC - Clarify that a mini usb cable is used on the STM32F3DISCOVERY (rust-embedded/book#381) - Update outdated qemu documentation (rust-embedded/book#403) - Add TRACE32 to Debuggers section (rust-embedded/book#406) - Add a link to Rust for Zephyr (rust-embedded/book#407) ## rust-lang/nomicon 4 commits in b8f254a991b8b7e8f704527f0d4f343a4697dfa9..cc6a6bae8c3bfa389974e533c54694662c1a9de6 2026-02-27 23:27:18 UTC to 2026-02-26 22:57:03 UTC - Fix `Vec::push_all` ptr code in exception-safety (rust-lang/nomicon#418) - Clarify parameter and argument compatibility (rust-lang/nomicon#516) - Improve grammar in Variance section (rust-lang/nomicon#515) - Explicit `extern "C"` ABI for FFI (rust-lang/nomicon#520) ## rust-lang/reference 7 commits in 50a1075e879be75aeec436252c84eef0fad489f4..c49e89cc8c7c2c43ca625a8d5b7ad9a53a9ce978 2026-03-04 15:39:00 UTC to 2026-03-01 06:34:18 UTC - Resolve grammar rules in link reference definitions (rust-lang/reference#2198) - Support non-ASCII Unicode in grammar rule names (rust-lang/reference#2196) - Fix grammar for block comments (rust-lang/reference#2191) - Fix an EN grammar error & add an item to place expr context list (rust-lang/reference#2189) - Align attribute template with applied conventions (rust-lang/reference#2194) - Update shebang (rust-lang/reference#2192) - Remove RESERVED_NUMBER (rust-lang/reference#2193)
rust-timer
added a commit
to rust-lang/rust
that referenced
this pull request
Mar 10, 2026
Rollup merge of #153619 - rustbot:docs-update, r=ehuss Update books ## rust-embedded/book 4 commits in 99d0341ff4e06757490af8fceee790c4ede50bc0..e88aa4403b4bf2071c8df9509160477e40179099 2026-02-28 20:13:44 UTC to 2026-02-28 20:07:25 UTC - Clarify that a mini usb cable is used on the STM32F3DISCOVERY (rust-embedded/book#381) - Update outdated qemu documentation (rust-embedded/book#403) - Add TRACE32 to Debuggers section (rust-embedded/book#406) - Add a link to Rust for Zephyr (rust-embedded/book#407) ## rust-lang/nomicon 4 commits in b8f254a991b8b7e8f704527f0d4f343a4697dfa9..cc6a6bae8c3bfa389974e533c54694662c1a9de6 2026-02-27 23:27:18 UTC to 2026-02-26 22:57:03 UTC - Fix `Vec::push_all` ptr code in exception-safety (rust-lang/nomicon#418) - Clarify parameter and argument compatibility (rust-lang/nomicon#516) - Improve grammar in Variance section (rust-lang/nomicon#515) - Explicit `extern "C"` ABI for FFI (rust-lang/nomicon#520) ## rust-lang/reference 7 commits in 50a1075e879be75aeec436252c84eef0fad489f4..c49e89cc8c7c2c43ca625a8d5b7ad9a53a9ce978 2026-03-04 15:39:00 UTC to 2026-03-01 06:34:18 UTC - Resolve grammar rules in link reference definitions (rust-lang/reference#2198) - Support non-ASCII Unicode in grammar rule names (rust-lang/reference#2196) - Fix grammar for block comments (rust-lang/reference#2191) - Fix an EN grammar error & add an item to place expr context list (rust-lang/reference#2189) - Align attribute template with applied conventions (rust-lang/reference#2194) - Update shebang (rust-lang/reference#2192) - Remove RESERVED_NUMBER (rust-lang/reference#2193)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This updates the shebang description, primarily to add a grammar for it. It also reworks the rules so the introduction explains what this section is talking about, and placing specific behaviors in individual rules.