-
Notifications
You must be signed in to change notification settings - Fork 572
Rename the ".general" rules #2133
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Conversation
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
This comment has been minimized.
This comment has been minimized.
traviscross
approved these changes
Jan 20, 2026
The "general" suffix seemed too generic to me, and also didn't quite fit with some of the style in the rest of the grammar. Some of these are difficult to come up with good names for, and I'm not entirely happy with this. My thinking is: - `.intro` is for informative introductions to a section. My intention is that every normative rule is testable. However, many of these `.intro` rules define terms, and I think those should possibly be normative (like [ISO/IEC Directives](https://www.iso.org/sites/directives/current/part2/index.xhtml#_idTextAnchor212)). I would like to rethink how `.intro` works. I appreciate having introductions that are more generalized, but it is often very difficult to introduce a section without defining some terms first. I would also like to come up with a better strategy of "this is a testable rule" versus "this rule defines a term, but that by isn't testable". - Switched some of these to be more specific words tailored to their context. - Used `.def` for some of these that *define* a thing. `.def` is used in a variety of other places. We have not standardized on it, and I'm not sure it is working in a way that is clear (is it defining a term? behavior? rule? general principle?). I think this is being used in ways that are inconsistent, and would like to figure out something better.
414edff to
36016fc
Compare
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. |
JonathanBrouwer
added a commit
to JonathanBrouwer/rust
that referenced
this pull request
Jan 26, 2026
Update books ## rust-lang/reference 5 commits in 28b5a54419985f03db5294de5eede71b6665b594..990819b86c22bbf538c0526f0287670f3dc1a67a 2026-01-20 20:46:59 UTC to 2026-01-14 01:48:22 UTC - Rename the ".general" rules (rust-lang/reference#2133) - Unwrap more chapters (rust-lang/reference#2134) - Add missing semicolon to ambiguity.glob-vs-glob (rust-lang/reference#2132) - Fix spacing with ordered lists (rust-lang/reference#2131) - Reflect explicit macro import in reference (rust-lang/reference#2077) ## rust-lang/rust-by-example 6 commits in 8de6ff811315ac3a96ebe01d74057382e42ffdee..bac931ef1673af63fb60c3d691633034713cca20 2026-01-25 21:02:15 UTC to 2026-01-14 19:45:27 UTC - Update supertraits.md (rust-lang/rust-by-example#1988) - Update question_mark.md (rust-lang/rust-by-example#1990) - Update deprecated functions in `Box::leak` example (rust-lang/rust-by-example#1992) - Improve Clone and Copy traits documentation (rust-lang/rust-by-example#1993) - Fix typo (rust-lang/rust-by-example#1986) - Korean translation! (rust-lang/rust-by-example#1985)
matthiaskrgr
added a commit
to matthiaskrgr/rust
that referenced
this pull request
Jan 26, 2026
Update books ## rust-lang/reference 5 commits in 28b5a54419985f03db5294de5eede71b6665b594..990819b86c22bbf538c0526f0287670f3dc1a67a 2026-01-20 20:46:59 UTC to 2026-01-14 01:48:22 UTC - Rename the ".general" rules (rust-lang/reference#2133) - Unwrap more chapters (rust-lang/reference#2134) - Add missing semicolon to ambiguity.glob-vs-glob (rust-lang/reference#2132) - Fix spacing with ordered lists (rust-lang/reference#2131) - Reflect explicit macro import in reference (rust-lang/reference#2077) ## rust-lang/rust-by-example 6 commits in 8de6ff811315ac3a96ebe01d74057382e42ffdee..bac931ef1673af63fb60c3d691633034713cca20 2026-01-25 21:02:15 UTC to 2026-01-14 19:45:27 UTC - Update supertraits.md (rust-lang/rust-by-example#1988) - Update question_mark.md (rust-lang/rust-by-example#1990) - Update deprecated functions in `Box::leak` example (rust-lang/rust-by-example#1992) - Improve Clone and Copy traits documentation (rust-lang/rust-by-example#1993) - Fix typo (rust-lang/rust-by-example#1986) - Korean translation! (rust-lang/rust-by-example#1985)
matthiaskrgr
added a commit
to matthiaskrgr/rust
that referenced
this pull request
Jan 26, 2026
Update books ## rust-lang/reference 5 commits in 28b5a54419985f03db5294de5eede71b6665b594..990819b86c22bbf538c0526f0287670f3dc1a67a 2026-01-20 20:46:59 UTC to 2026-01-14 01:48:22 UTC - Rename the ".general" rules (rust-lang/reference#2133) - Unwrap more chapters (rust-lang/reference#2134) - Add missing semicolon to ambiguity.glob-vs-glob (rust-lang/reference#2132) - Fix spacing with ordered lists (rust-lang/reference#2131) - Reflect explicit macro import in reference (rust-lang/reference#2077) ## rust-lang/rust-by-example 6 commits in 8de6ff811315ac3a96ebe01d74057382e42ffdee..bac931ef1673af63fb60c3d691633034713cca20 2026-01-25 21:02:15 UTC to 2026-01-14 19:45:27 UTC - Update supertraits.md (rust-lang/rust-by-example#1988) - Update question_mark.md (rust-lang/rust-by-example#1990) - Update deprecated functions in `Box::leak` example (rust-lang/rust-by-example#1992) - Improve Clone and Copy traits documentation (rust-lang/rust-by-example#1993) - Fix typo (rust-lang/rust-by-example#1986) - Korean translation! (rust-lang/rust-by-example#1985)
Zalathar
added a commit
to Zalathar/rust
that referenced
this pull request
Jan 27, 2026
Update books ## rust-lang/reference 5 commits in 28b5a54419985f03db5294de5eede71b6665b594..990819b86c22bbf538c0526f0287670f3dc1a67a 2026-01-20 20:46:59 UTC to 2026-01-14 01:48:22 UTC - Rename the ".general" rules (rust-lang/reference#2133) - Unwrap more chapters (rust-lang/reference#2134) - Add missing semicolon to ambiguity.glob-vs-glob (rust-lang/reference#2132) - Fix spacing with ordered lists (rust-lang/reference#2131) - Reflect explicit macro import in reference (rust-lang/reference#2077) ## rust-lang/rust-by-example 6 commits in 8de6ff811315ac3a96ebe01d74057382e42ffdee..bac931ef1673af63fb60c3d691633034713cca20 2026-01-25 21:02:15 UTC to 2026-01-14 19:45:27 UTC - Update supertraits.md (rust-lang/rust-by-example#1988) - Update question_mark.md (rust-lang/rust-by-example#1990) - Update deprecated functions in `Box::leak` example (rust-lang/rust-by-example#1992) - Improve Clone and Copy traits documentation (rust-lang/rust-by-example#1993) - Fix typo (rust-lang/rust-by-example#1986) - Korean translation! (rust-lang/rust-by-example#1985)
rust-timer
added a commit
to rust-lang/rust
that referenced
this pull request
Jan 27, 2026
Rollup merge of #151699 - rustbot:docs-update, r=ehuss Update books ## rust-lang/reference 5 commits in 28b5a54419985f03db5294de5eede71b6665b594..990819b86c22bbf538c0526f0287670f3dc1a67a 2026-01-20 20:46:59 UTC to 2026-01-14 01:48:22 UTC - Rename the ".general" rules (rust-lang/reference#2133) - Unwrap more chapters (rust-lang/reference#2134) - Add missing semicolon to ambiguity.glob-vs-glob (rust-lang/reference#2132) - Fix spacing with ordered lists (rust-lang/reference#2131) - Reflect explicit macro import in reference (rust-lang/reference#2077) ## rust-lang/rust-by-example 6 commits in 8de6ff811315ac3a96ebe01d74057382e42ffdee..bac931ef1673af63fb60c3d691633034713cca20 2026-01-25 21:02:15 UTC to 2026-01-14 19:45:27 UTC - Update supertraits.md (rust-lang/rust-by-example#1988) - Update question_mark.md (rust-lang/rust-by-example#1990) - Update deprecated functions in `Box::leak` example (rust-lang/rust-by-example#1992) - Improve Clone and Copy traits documentation (rust-lang/rust-by-example#1993) - Fix typo (rust-lang/rust-by-example#1986) - Korean translation! (rust-lang/rust-by-example#1985)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The "general" suffix seemed too generic to me, and also didn't quite fit with some of the style in the rest of the grammar.
Some of these are difficult to come up with good names for, and I'm not entirely happy with this. My thinking is:
.introis for informative introductions to a section. My intention is that every normative rule is testable. However, many of these.introrules define terms, and I think those should possibly be normative (like ISO/IEC Directives).I would like to rethink how
.introworks. I appreciate having introductions that are more generalized, but it is often very difficult to introduce a section without defining some terms first.I would also like to come up with a better strategy of "this is a testable rule" versus "this rule defines a term, but that by itself isn't testable".
Switched some of these to be more specific words tailored to their context.
Used
.deffor some of these that define a thing..defis used in a variety of other places. We have not standardized on it, and I'm not sure it is working in a way that is clear (is it defining a term? behavior? rule? general principle?).I think this is being used in ways that are inconsistent, and would like to figure out something better.