rustdoc: don't link doc(hidden) associated type projections#157438
Merged
rust-bors[bot] merged 2 commits intoJun 5, 2026
Conversation
rustbot
added
S-waiting-on-author
rustbot
added
the
S-waiting-on-review
rustbot
removed
the
S-waiting-on-author
Collaborator
|
r? @notriddle rustbot has assigned @notriddle. Use Why was this reviewer chosen?The reviewer was selected based on:
|
notriddle
approved these changes
Jun 5, 2026
Contributor
|
@bors r+ |
Contributor
rust-bors
Bot
added
S-waiting-on-bors
jhpratt
added a commit
to jhpratt/rust
that referenced
this pull request
Jun 5, 2026
…-link, r=notriddle rustdoc: don't link doc(hidden) associated type projections Rustdoc renders associated type projections like `T::Foo` by linking `Foo` to the containing trait page and appending `#associatedtype.Foo`. For `#[doc(hidden)]` associated types, that anchor is not rendered in normal docs, so this can produce dangling links. This PR checks the corresponding trait associated item before emitting the projection link. When the associated type is hidden, rustdoc leaves the projection text plain, accounting for `--document-hidden-items` as well. Fixes rust-lang#151454.
rust-bors Bot
pushed a commit
that referenced
this pull request
Jun 5, 2026
Rollup of 12 pull requests Successful merges: - #155453 (apply Cortex-A53 errata 843419 mitigation to the AArch64 Linux targets) - #156798 (delegation: do not always generate first argument) - #157438 (rustdoc: don't link doc(hidden) associated type projections) - #157450 (mark `Encode`, `Decode`, `Mark` impls as `#[inline]`) - #148183 (rustdoc: Test & document `test_harness` code block attribute) - #157190 (Silence recursive RUSTC_LOG_FORMAT_JSON messages) - #157396 (Add @aapoalas to libs review rotation) - #157470 (Avoid ICE when emitting TargetMachine config errors) - #157474 (Forbid optimize(none) with inline(always) or inline.) - #157475 (Add a smoke test for the optimize attribute.) - #157479 (Warn when `#[macro_use]` or `#[macro_escape]` is used on the crate root) - #157486 (Remove unused attributes from issue-29485.rs.) Failed merges: - #157485 (Rename `errors.rs` file to `diagnostics.rs`)
rust-bors Bot
pushed a commit
that referenced
this pull request
Jun 5, 2026
Rollup of 12 pull requests Successful merges: - #157467 (stdarch subtree update) - #155453 (apply Cortex-A53 errata 843419 mitigation to the AArch64 Linux targets) - #156798 (delegation: do not always generate first argument) - #157438 (rustdoc: don't link doc(hidden) associated type projections) - #157450 (mark `Encode`, `Decode`, `Mark` impls as `#[inline]`) - #157190 (Silence recursive RUSTC_LOG_FORMAT_JSON messages) - #157396 (Add @aapoalas to libs review rotation) - #157470 (Avoid ICE when emitting TargetMachine config errors) - #157474 (Forbid optimize(none) with inline(always) or inline.) - #157475 (Add a smoke test for the optimize attribute.) - #157479 (Warn when `#[macro_use]` or `#[macro_escape]` is used on the crate root) - #157486 (Remove unused attributes from issue-29485.rs.) Failed merges: - #157485 (Rename `errors.rs` file to `diagnostics.rs`)
GuillaumeGomez
added a commit
to GuillaumeGomez/rust
that referenced
this pull request
Jun 5, 2026
…-link, r=notriddle rustdoc: don't link doc(hidden) associated type projections Rustdoc renders associated type projections like `T::Foo` by linking `Foo` to the containing trait page and appending `#associatedtype.Foo`. For `#[doc(hidden)]` associated types, that anchor is not rendered in normal docs, so this can produce dangling links. This PR checks the corresponding trait associated item before emitting the projection link. When the associated type is hidden, rustdoc leaves the projection text plain, accounting for `--document-hidden-items` as well. Fixes rust-lang#151454.
| // Regression test for https://github.com/rust-lang/rust/issues/151454. | ||
| //@ has foo/fn.hidden_projection.html | ||
| //@ has - '//pre[@class="rust item-decl"]' 'T::Foo' | ||
| //@ !has - '//pre[@class="rust item-decl"]//a[@href="trait.Trait.html#associatedtype.Foo"]' 'Foo' |
Member
There was a problem hiding this comment.
Would likely have been better to check that there is a Foo element but not in a link. !has is very bad for DOM changes.
Contributor
Author
There was a problem hiding this comment.
i can make a follow up PR on this, if you don't mind?
Merged
jhpratt
added a commit
to jhpratt/rust
that referenced
this pull request
Jun 7, 2026
…aumeGomez Test fixup Follow up to rust-lang#157438. r? @GuillaumeGomez
rust-timer
added a commit
that referenced
this pull request
Jun 8, 2026
Rollup merge of #157581 - qaijuang:157438-follow-up, r=GuillaumeGomez Test fixup Follow up to #157438. r? @GuillaumeGomez
github-actions Bot
pushed a commit
to rust-lang/stdarch
that referenced
this pull request
Jun 8, 2026
Rollup of 12 pull requests Successful merges: - rust-lang/rust#157467 (stdarch subtree update) - rust-lang/rust#155453 (apply Cortex-A53 errata 843419 mitigation to the AArch64 Linux targets) - rust-lang/rust#156798 (delegation: do not always generate first argument) - rust-lang/rust#157438 (rustdoc: don't link doc(hidden) associated type projections) - rust-lang/rust#157450 (mark `Encode`, `Decode`, `Mark` impls as `#[inline]`) - rust-lang/rust#157190 (Silence recursive RUSTC_LOG_FORMAT_JSON messages) - rust-lang/rust#157396 (Add @aapoalas to libs review rotation) - rust-lang/rust#157470 (Avoid ICE when emitting TargetMachine config errors) - rust-lang/rust#157474 (Forbid optimize(none) with inline(always) or inline.) - rust-lang/rust#157475 (Add a smoke test for the optimize attribute.) - rust-lang/rust#157479 (Warn when `#[macro_use]` or `#[macro_escape]` is used on the crate root) - rust-lang/rust#157486 (Remove unused attributes from issue-29485.rs.) Failed merges: - rust-lang/rust#157485 (Rename `errors.rs` file to `diagnostics.rs`)
github-actions Bot
pushed a commit
to rust-lang/stdarch
that referenced
this pull request
Jun 8, 2026
Test fixup Follow up to rust-lang/rust#157438. r? @GuillaumeGomez
asukaminato0721
pushed a commit
to asukaminato0721/rust-analyzer
that referenced
this pull request
Jun 8, 2026
Test fixup Follow up to rust-lang/rust#157438. 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
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.
Rustdoc renders associated type projections like
T::Fooby linkingFooto the containing trait page and appending#associatedtype.Foo.For
#[doc(hidden)]associated types, that anchor is not rendered in normal docs, so this can produce dangling links.This PR checks the corresponding trait associated item before emitting the projection link.
When the associated type is hidden, rustdoc leaves the projection text plain, accounting for
--document-hidden-itemsas well.Fixes #151454.