rustdoc: Improve calculation of "Impls on Foreign Types" #97613
Merged
Conversation
This file contains 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
jsha
added
T-rustdoc
rust-highfive
added
the
S-waiting-on-review
jsha
force-pushed
the
implementation-is-on-local-type
branch
from
e1885d8 to
d1cb64f
Compare
This comment has been minimized.
This comment has been minimized.
GuillaumeGomez
approved these changes
Jun 1, 2022
|
Looks like a good idea to me. |
jsha
force-pushed
the
implementation-is-on-local-type
branch
from
d1cb64f to
37d3638
Compare
|
Thanks! @bors r+ |
|
📌 Commit 37d3638 has been approved by |
bors
added
S-waiting-on-bors
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Jun 1, 2022
Rollup of 6 pull requests Successful merges: - rust-lang#95594 (Additional `*mut [T]` methods) - rust-lang#97130 (rustdoc: avoid including impl blocks with filled-in generics) - rust-lang#97166 (Move conditions out of recover/report functions.) - rust-lang#97605 (Mention filename in suggestion when it differs from primary span) - rust-lang#97613 (rustdoc: Improve calculation of "Impls on Foreign Types") - rust-lang#97626 (rename PointerAddress → PointerExposeAddress) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup
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 existing code to calculate whether an implementation was on a "Foreign Type" was duplicated across the sidebar generation and the page generation. It also came to the wrong conclusion for some cases where both the trait and the "for" type were re-exports.
This PR extracts the logic into a method of
Impl, breaks it into a multi-line method so it can be commented, and adds a case for when the trait and the "for" type came from the same crate. This fixes some cases - like the platform-specific integer types (__m256,__m128, etc). But it doesn't fix all cases. See the screenshots below.Before:
After:
The remaining types (
CString,NulError, etc) are all from thealloccrate, while theClonetrait is from thecorecrate. SinceCStringandCloneare both re-exported bystd, they are logically local to each other, but I couldn't figure out a good way to detect that in this code. I figure this is still a good step forward.Related: #97610
r? @camelid