rustdoc: some clarifying comments - #161890
Merged
Merged
Conversation
rustbot
added
S-waiting-on-review
RalfJung
commented
Aug 27, 2026
| crate_attrs: String, | ||
| /// Outer attributes from the source that can be put into a module (and therefore do not inhibit | ||
| /// merging: even in the merged test, the attributes can be isolated to the test). | ||
| maybe_crate_attrs: String, |
Member
Author
There was a problem hiding this comment.
Is there a reason these aren't called module_attrs or so? "maybe crate attribute" makes no sense at all to me, and the code doesn't treat them like "maybe" either.
Member
There was a problem hiding this comment.
Bad code evolution. At some point we checked that in two passes, but finally removed the second pass. Can be (and should be renamed). 👍
GuillaumeGomez
approved these changes
Aug 27, 2026
RalfJung
force-pushed
the
rustdoc-comments
branch
from
August 27, 2026 21:32
f779e99 to
4dfdec1
Compare
RalfJung
force-pushed
the
rustdoc-comments
branch
from
August 27, 2026 21:53
1e009da to
d26c505
Compare
Member
Author
|
Fair points, all done. |
RalfJung
force-pushed
the
rustdoc-comments
branch
from
August 27, 2026 21:54
d26c505 to
5bf30ad
Compare
GuillaumeGomez
approved these changes
Aug 27, 2026
Member
|
Thanks for the improvements! :) |
Member
Author
|
@bors r=GuillaumeGomez rollup |
Contributor
rust-bors
Bot
added
S-waiting-on-bors
JonathanBrouwer
added a commit
to JonathanBrouwer/rust
that referenced
this pull request
Aug 28, 2026
…aumeGomez rustdoc: some clarifying comments I had to dig into rustdoc for [this recent adventure](https://rust-lang.zulipchat.com/#narrow/channel/266220-t-rustdoc/topic/Strange.20behavior.20for.20rustc_builtin_lints.20doctests/with/619633123) and learned some things that I found far from obvious from the code. Add some comments to make this easier for the next adventurer going down the same path. r? @GuillaumeGomez
rust-bors Bot
pushed a commit
that referenced
this pull request
Aug 28, 2026
…uwer Rollup of 21 pull requests Successful merges: - #158609 (Update sccache to 0.16.0) - #150075 (Implement clamp_to) - #159103 (fix(reborrow): recursive implementation) - #160562 (add target feature ABI checks for SPARC) - #160848 (std: avoid aliasing violations when wrapping opaque C types) - #161421 (Include startup crt objects on WASI for more outputs) - #161805 (Prefer ambiguous candidates when deduplicating traits in scope, so `ambiguous_glob_imported_traits` doesn't depend on import order) - #161862 (Put data segment in specified section with link_section on wasm) - #161866 (delegation: add tests fixating behavior of delegating to default trait implementations) - #161456 (reduce perf impact of scalar size checks) - #161528 (Add regression test to ensure optimal compilation) - #161666 (Print vendor instructions in `x vendor`) - #161730 (Improve type mismatch annotation for lets with block-wrapped initializers) - #161828 (Never type after-stabilization cleanup) - #161859 (Do not optimize MIR for comptime ConstFns) - #161860 (atomicptr.rs test: remove unused import) - #161870 (bind to [::1] instead of 127.0.0.1 in documentation examples for v6 UDP methods) - #161876 (rustdoc: Correctly handle when a macro generates multiple items in `--generate-macro-expansion`) - #161889 (Add link to ownership section in ptr::read docs) - #161890 (rustdoc: some clarifying comments) - #161891 (Mark `extern_item_impls` feature as incomplete) Failed merges: - #161702 (Use `drop_guard` in some places in {core,alloc,std})
rust-bors Bot
pushed a commit
that referenced
this pull request
Aug 28, 2026
…uwer Rollup of 21 pull requests Successful merges: - #150075 (Implement clamp_to) - #159103 (fix(reborrow): recursive implementation) - #160562 (add target feature ABI checks for SPARC) - #160848 (std: avoid aliasing violations when wrapping opaque C types) - #161421 (Include startup crt objects on WASI for more outputs) - #161805 (Prefer ambiguous candidates when deduplicating traits in scope, so `ambiguous_glob_imported_traits` doesn't depend on import order) - #161862 (Put data segment in specified section with link_section on wasm) - #161866 (delegation: add tests fixating behavior of delegating to default trait implementations) - #157218 (Track items behind `cfg_select` in the same way we do for `cfg`) - #161456 (reduce perf impact of scalar size checks) - #161528 (Add regression test to ensure optimal compilation) - #161666 (Print vendor instructions in `x vendor`) - #161730 (Improve type mismatch annotation for lets with block-wrapped initializers) - #161828 (Never type after-stabilization cleanup) - #161859 (Do not optimize MIR for comptime ConstFns) - #161860 (atomicptr.rs test: remove unused import) - #161870 (bind to [::1] instead of 127.0.0.1 in documentation examples for v6 UDP methods) - #161876 (rustdoc: Correctly handle when a macro generates multiple items in `--generate-macro-expansion`) - #161889 (Add link to ownership section in ptr::read docs) - #161890 (rustdoc: some clarifying comments) - #161891 (Mark `extern_item_impls` feature as incomplete) Failed merges: - #161702 (Use `drop_guard` in some places in {core,alloc,std})
rust-bors Bot
pushed a commit
that referenced
this pull request
Aug 28, 2026
Rollup merge of #161890 - RalfJung:rustdoc-comments, r=GuillaumeGomez rustdoc: some clarifying comments I had to dig into rustdoc for [this recent adventure](https://rust-lang.zulipchat.com/#narrow/channel/266220-t-rustdoc/topic/Strange.20behavior.20for.20rustc_builtin_lints.20doctests/with/619633123) and learned some things that I found far from obvious from the code. Add some comments to make this easier for the next adventurer going down the same path. r? @GuillaumeGomez
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.
I had to dig into rustdoc for this recent adventure and learned some things that I found far from obvious from the code. Add some comments to make this easier for the next adventurer going down the same path.
r? @GuillaumeGomez