rustdoc: don't link doc(hidden) associated type projections#157438
Open
qaijuang wants to merge 2 commits into
Open
rustdoc: don't link doc(hidden) associated type projections#157438qaijuang wants to merge 2 commits into
qaijuang wants to merge 2 commits into
Conversation
Collaborator
|
r? @notriddle rustbot has assigned @notriddle. Use Why was this reviewer chosen?The reviewer was selected based on:
|
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
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.