Fix intra-doc links for inherent impls that are both lang items and not the default impl #75649
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
jyn514
added
T-rustdoc
|
Some changes occurred in intra-doc-links. cc @jyn514 |
rust-highfive
added
the
S-waiting-on-review
This comment has been minimized.
This comment has been minimized.
jyn514
force-pushed
the
inherent-lang-impls
branch
from
af913c5 to
1b74f04
Compare
|
This does keep one small change from #74489, which is to use |
jyn514
changed the title
jyn514
force-pushed
the
inherent-lang-impls
branch
from
3aae334 to
7be824e
Compare
|
Nice work! @bors: r+ |
|
📌 Commit 7be824e has been approved by |
bors
added
S-waiting-on-bors
tmandry
added a commit
to tmandry/rust
that referenced
this pull request
Aug 18, 2020
…aumeGomez Fix intra-doc links for inherent impls that are both lang items and not the default impl I found in rust-lang#75464 (comment) that `str::to_uppercase()` doesn't resolve while `str::trim()` does. The only real difference is that `to_uppercase` is defined in `alloc`, while trim is defined in `core`. It turns out that rustdoc was ignoring `lang_items.str_alloc_impl()` - it saw them in `collect_trait_impls`, but not for intra-doc links. This uses the same `impls` for all parts of rustdoc, so that there can be no more inconsistency. It does have the slight downside that the matches are no longer exhaustive but it will be very clear if a new lang item is missed because it will panic when you try to document it (and if you don't document it, does rustdoc really need to know about it?). ~~This needs a test case (probably just `str::to_uppercase`).~~ Added. This is best reviewed commit-by-commit. r? @GuillaumeGomez
tmandry
added a commit
to tmandry/rust
that referenced
this pull request
Aug 18, 2020
…aumeGomez Fix intra-doc links for inherent impls that are both lang items and not the default impl I found in rust-lang#75464 (comment) that `str::to_uppercase()` doesn't resolve while `str::trim()` does. The only real difference is that `to_uppercase` is defined in `alloc`, while trim is defined in `core`. It turns out that rustdoc was ignoring `lang_items.str_alloc_impl()` - it saw them in `collect_trait_impls`, but not for intra-doc links. This uses the same `impls` for all parts of rustdoc, so that there can be no more inconsistency. It does have the slight downside that the matches are no longer exhaustive but it will be very clear if a new lang item is missed because it will panic when you try to document it (and if you don't document it, does rustdoc really need to know about it?). ~~This needs a test case (probably just `str::to_uppercase`).~~ Added. This is best reviewed commit-by-commit. r? @GuillaumeGomez
tmandry
added a commit
to tmandry/rust
that referenced
this pull request
Aug 19, 2020
…aumeGomez Fix intra-doc links for inherent impls that are both lang items and not the default impl I found in rust-lang#75464 (comment) that `str::to_uppercase()` doesn't resolve while `str::trim()` does. The only real difference is that `to_uppercase` is defined in `alloc`, while trim is defined in `core`. It turns out that rustdoc was ignoring `lang_items.str_alloc_impl()` - it saw them in `collect_trait_impls`, but not for intra-doc links. This uses the same `impls` for all parts of rustdoc, so that there can be no more inconsistency. It does have the slight downside that the matches are no longer exhaustive but it will be very clear if a new lang item is missed because it will panic when you try to document it (and if you don't document it, does rustdoc really need to know about it?). ~~This needs a test case (probably just `str::to_uppercase`).~~ Added. This is best reviewed commit-by-commit. r? @GuillaumeGomez
|
Failed in #75688 (comment) due to Cargo.lock being out of date |
bors
added
S-waiting-on-author
|
☔ The latest upstream changes (presumably #75692) made this pull request unmergeable. Please resolve the merge conflicts. |
jyn514
force-pushed
the
inherent-lang-impls
branch
from
7be824e to
570b0d9
Compare
|
@bors r=GuilluameGomez |
|
📌 Commit 570b0d9 has been approved by |
bors
added
S-waiting-on-bors
|
@bors r- I want to add a test for f32 and f64 methods. |
bors
added
S-waiting-on-author
jyn514
force-pushed
the
inherent-lang-impls
branch
from
2fa9719 to
aff01f8
Compare
|
Tagging you so you can look at the changes if you want :) but it's only adding a new test. |
|
📌 Commit aff01f8 has been approved by |
bors
added
S-waiting-on-bors
tmandry
added a commit
to tmandry/rust
that referenced
this pull request
Aug 19, 2020
…aumegomez Fix intra-doc links for inherent impls that are both lang items and not the default impl I found in rust-lang#75464 (comment) that `str::to_uppercase()` doesn't resolve while `str::trim()` does. The only real difference is that `to_uppercase` is defined in `alloc`, while trim is defined in `core`. It turns out that rustdoc was ignoring `lang_items.str_alloc_impl()` - it saw them in `collect_trait_impls`, but not for intra-doc links. This uses the same `impls` for all parts of rustdoc, so that there can be no more inconsistency. It does have the slight downside that the matches are no longer exhaustive but it will be very clear if a new lang item is missed because it will panic when you try to document it (and if you don't document it, does rustdoc really need to know about it?). ~~This needs a test case (probably just `str::to_uppercase`).~~ Added. This is best reviewed commit-by-commit. r? @GuillaumeGomez
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Aug 19, 2020
Rollup of 7 pull requests Successful merges: - rust-lang#75069 (move const param structural match checks to wfcheck) - rust-lang#75587 (mir building: fix some comments) - rust-lang#75593 (Adjust installation place for compiler docs) - rust-lang#75648 (Make OnceCell<T> transparent to dropck) - rust-lang#75649 (Fix intra-doc links for inherent impls that are both lang items and not the default impl) - rust-lang#75674 (Move to intra doc links for std::io) - rust-lang#75696 (Remove `#[cfg(miri)]` from OnceCell tests) Failed merges: r? @ghost
This was referenced Aug 23, 2020
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.
I found in #75464 (comment) that
str::to_uppercase()doesn't resolve whilestr::trim()does. The only real difference is thatto_uppercaseis defined inalloc, while trim is defined incore. It turns out that rustdoc was ignoringlang_items.str_alloc_impl()- it saw them incollect_trait_impls, but not for intra-doc links.This uses the same
implsfor all parts of rustdoc, so that there can be no more inconsistency. It does have the slight downside that the matches are no longer exhaustive but it will be very clear if a new lang item is missed because it will panic when you try to document it (and if you don't document it, does rustdoc really need to know about it?).This needs a test case (probably justAdded.str::to_uppercase).This is best reviewed commit-by-commit.
r? @GuillaumeGomez