Repository navigation
[rustdoc] Render Deref methods on aliased items - #163571
Open
GuillaumeGomez wants to merge 8 commits into
Open
GuillaumeGomez wants to merge 8 commits into
GuillaumeGomez wants to merge 8 commits into
Conversation
rustbot
added
S-waiting-on-review
Collaborator
|
|
GuillaumeGomez
commented
Sep 30, 2026
| let mut assoc_types = Vec::new(); | ||
| let mut assoc_fns = Vec::new(); | ||
| let mut methods = Vec::new(); | ||
| if let Some(v) = cache.impls.get(&did) { |
Member
Author
There was a problem hiding this comment.
Most of this diff comes from the removal of one level of indent which became (a few lines above):
let v = match cache.impls.get(&item_def_id) {
Some(impls) => impls.as_slice(),
None if aliased_type.is_some() => &[],
None => return,
};Since we don't render anything, we should have returned early. Now it's done, but ugly diff.
GuillaumeGomez
commented
Sep 30, 2026
| @@ -54,7 +54,7 @@ impl std::ops::Deref for GenericStruct<u32> { | |||
| pub struct Wrap<T>(GenericStruct<T>); | |||
|
|
|||
| //@ has 'foo/type.Alias.html' | |||
| //@ !has - '//h2' 'Methods from Deref<Target = u32>' | |||
| //@ has - '//h2' 'Methods from Deref<Target = u32>' | |||
Member
Author
There was a problem hiding this comment.
Now we have a Deref on type aliases, so we update here. :3
GuillaumeGomez
commented
Sep 30, 2026
| let for_ty = self.cx.tcx().type_of(impl_did).skip_binder(); | ||
| let reject_cx = DeepRejectCtxt::relate_infer_infer(self.cx.tcx()); | ||
| if !reject_cx.types_may_unify(aliased_ty, for_ty) { | ||
| if !super::impl_may_apply_to_type_alias(self.cx.tcx(), self_did, impl_did) { |
Member
Author
There was a problem hiding this comment.
Like I mentioned in the first comment, took this code and re-used it to filter which Deref was matching the aliased ty.
GuillaumeGomez
commented
Sep 30, 2026
| let mut deref_impl = None; | ||
| let mut has_deref_mut = false; | ||
|
|
||
| for impl_ in impls { |
Member
Author
There was a problem hiding this comment.
To avoid doing two loops (one to get Deref and the other to check if we also implement DerefMut), inlined it into one.
lolbinarycat
reviewed
Oct 1, 2026
Contributor
|
@rustbot author |
rustbot
added
S-waiting-on-author
Contributor
|
one more thing: can you check locally if these change fixes the issues with |
Member
Author
Confirmed it's fixed. Added the code from the first comment of the issue as regression test. |
Member
Author
|
Applied all suggestions. @rustbot ready |
rustbot
added
S-waiting-on-review
This comment has been minimized.
This comment has been minimized.
Member
Author
|
Had to remove the |
lolbinarycat
reviewed
Oct 2, 2026
| if let Some(self_def_id) = self_cleared.def_id(&cache) | ||
| && let Some(other_def_id) = other_cleared.def_id(&cache) | ||
| { | ||
| return impl_may_apply_to_type_alias(cx.tcx(), self_def_id, other_def_id); |
Contributor
There was a problem hiding this comment.
this (and my patch) are still subtly wrong, as the special rustdoc-specific rules is_doc_subtype_of implements won't apply when type aliases are involved. still an improvement over the status quo, but worth a note.
Contributor
There was a problem hiding this comment.
if i understand the code correctly, Option<u8> and Option<&u8> will compare as doc subtypes, but Option<AliasOfRefU8> and Option<u8> won't.
Member
Author
There was a problem hiding this comment.
Might be worth a test to confirm that. Gonna add one.
Member
Author
There was a problem hiding this comment.
Nope, it works. Adding test. =D
Member
Author
There was a problem hiding this comment.
Ah no nevermind, the filtering is not working. Too laxist. Oh well, that will be a follow-up. :')
Member
Author
|
Added a test which illustrates the current limitations around type aliases. |
This comment has been minimized.
This comment has been minimized.
GuillaumeGomez
force-pushed
the
deref-on-aliased
branch
from
October 6, 2026 09:56
c106bca to
7259f23
Compare
This comment has been minimized.
This comment has been minimized.
Member
Author
|
CI passed. |
This comment has been minimized.
This comment has been minimized.
GuillaumeGomez
force-pushed
the
deref-on-aliased
branch
from
October 15, 2026 21:15
7259f23 to
dcb9f0b
Compare
This comment has been minimized.
This comment has been minimized.
Collaborator
|
This PR was rebased onto a different main commit. Here's a range-diff highlighting what actually changed. Rebasing is a normal part of keeping PRs up to date, so no action is needed—this note is just to help reviewers. |
Member
Author
|
Fixed merge conflict. |
Member
Author
|
ping @lolbinarycat ;) |
Member
Author
|
r? @Urgau |
Urgau
reviewed
Nov 5, 2026
Member
Author
|
Done! |
Urgau
reviewed
Nov 5, 2026
| pub type X = Foo<i32>; | ||
|
|
||
| //@ has 'foo/struct.Bar.html' | ||
| // FIXME: Only `get_i32` should be listed, this is a bug. |
Member
There was a problem hiding this comment.
I don't enough the code, could explain both are listed? and how prevalent this pattern is?
Member
Author
There was a problem hiding this comment.
I think it's because the type normalization is incomplete. I didn't look into it in details yet as the PR is already way too big.
Member
There was a problem hiding this comment.
I understand but showing false information is not great, I would prefer to not show enough rather than too much (it's still false but I think less so).
As I understand this is only gonna impact impls for concrete types of a generic type, is that right? If it's only this case then it's probably not much, my feel is that most use-case do impl<T> rather than specific types.
Member
Author
There was a problem hiding this comment.
I couldn't reproduce it in other contexts than type aliases. And once this PR is fixed, first thing I do is fixing that bug.
Urgau
reviewed
Nov 5, 2026
Urgau
approved these changes
Nov 7, 2026
Member
|
@bors r+ rollup |
Contributor
rust-bors
Bot
added
S-waiting-on-bors
Zalathar
added a commit
to Zalathar/rust
that referenced
this pull request
Nov 7, 2026
…=Urgau [rustdoc] Render `Deref` methods on aliased items Fixes rust-lang#134868. Fixes rust-lang#24686. The biggest issue was to make it work only for the matching aliased type generics. Luckily for me, it was already done in `write_shared.rs` (where we generate the JS file containing the impls that we then put into the generated web pages, which makes me wonder why we don't put that directly into the page by default, but debate for another day...). r? @lolbinarycat
rust-bors Bot
pushed a commit
that referenced
this pull request
Nov 7, 2026
Rollup of 5 pull requests Successful merges: - #164784 (Introduce OptimizationObjective and fix the entry shim's size attributes) - #147696 (Implement `bit` and `set_bit` for integral types.) - #163202 (nuttx: use updated pollfd definition) - #163571 ([rustdoc] Render `Deref` methods on aliased items) - #165482 (apply `-Zcrate-attr` attributes before the crate attributes)
Zalathar
added a commit
to Zalathar/rust
that referenced
this pull request
Nov 7, 2026
…=Urgau [rustdoc] Render `Deref` methods on aliased items Fixes rust-lang#134868. Fixes rust-lang#24686. The biggest issue was to make it work only for the matching aliased type generics. Luckily for me, it was already done in `write_shared.rs` (where we generate the JS file containing the impls that we then put into the generated web pages, which makes me wonder why we don't put that directly into the page by default, but debate for another day...). r? @lolbinarycat
Member
|
rust-bors
Bot
added
S-waiting-on-author
Contributor
|
This pull request was unapproved. This PR was contained in a rollup (#165591), which was unapproved. |
rust-bors Bot
pushed a commit
that referenced
this pull request
Nov 7, 2026
[rustdoc] Render `Deref` methods on aliased items try-job: dist-x86_64-linux-alt
This comment has been minimized.
This comment has been minimized.
Contributor
|
💔 Test for 505fffa failed: CI. Failed job:
|
Collaborator
|
The job Click to see the possible cause of the failure (guessed by this bot) |
This branch has not been deployed
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.
View all comments
Fixes #134868.
Fixes #24686.
The biggest issue was to make it work only for the matching aliased type generics. Luckily for me, it was already done in
write_shared.rs(where we generate the JS file containing the impls that we then put into the generated web pages, which makes me wonder why we don't put that directly into the page by default, but debate for another day...).r? @lolbinarycat