Update rustdoc passes documentation#2827
Open
cijiugechu wants to merge 1 commit into
Open
Conversation
Align the rustdoc internals guide with the current pass definitions and execution order so the documented names, conditions, and coverage behavior match the source.
Collaborator
|
Thanks for the PR. If you have write access, feel free to merge this PR if it does not need reviews. You can request a review using |
rustbot
added
the
S-waiting-on-review
Member
Author
|
r? rustc-dev-guide |
jyn514
requested changes
May 21, 2026
Comment on lines
+96
to
+100
| the cleaned [`AST`][ast]. Several of these passes are `lint`s and reports, but | ||
| some of them mutate or generate new items. These are implemented in the | ||
| [`librustdoc/passes`] directory, generally one module per pass. Unlike the | ||
| previous set of [`AST`][ast] transformations, these passes are run on the | ||
| cleaned crate. |
Member
There was a problem hiding this comment.
nit: we try to use one sentence per line in new docs.
rustbot
added
S-waiting-on-author
Member
Author
Ah, my bad. I overlooked whether this restructure improved docs. I was focused on reflecting the current source code's structure. |
Member
Author
|
I’ll try to revisit this these days. |
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
4 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.
Align the rustdoc internals guide with the current pass definitions and execution order.