Open
Conversation
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.
rustbot
added
the
S-waiting-on-review
ehuss
reviewed
Mar 4, 2026
| ~LF* (LF | EOF) | ||
| ``` | ||
|
|
||
| r[shebang.intro] |
Contributor
There was a problem hiding this comment.
Is there a reason the intro was moved to be below the syntax?
Generally I'd like to move to an outline where sections are generally organized so they start with an introduction, then have the syntax, then key behaviors and rules, and then more minutia like restrictions.
I realize there are big sections of the reference that still have the syntax first, but I would prefer to move to this style.
Contributor
Author
There was a problem hiding this comment.
No reason other than, as you say, matching similar nearby chapters. I had similarly considered it both ways. I'll move it.
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.
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.
cc @ehuss