rustdoc: Fix intra-doc link bugs involving type aliases and associated items #150586

camelid · 2026-01-02T07:51:47Z

This PR:

Add support for linking to fields of variants behind a type alias.
Correctly resolve links to fields and variants behind a type alias to the alias's version of the docs.
Refactor some intra-doc links code to make it simpler.
Add tests for the status quo of linking to associated items behind aliases.

Future steps:

Nail down the rules of when inherent and trait impls are inlined into an alias's docs, and when impls on the alias appear for the aliased type.
Adjust the resolutions of intra-doc links, through aliases, to associated items based on these rules.

r? @GuillaumeGomez

GuillaumeGomez · 2026-01-02T13:14:12Z

Is it ready for review? (It's a draft so wondering ^^')

camelid · 2026-01-02T19:13:44Z

I'm planning to add one more commit, but it's mostly done.

camelid · 2026-01-02T19:14:03Z

It's best reviewed commit-by-commit btw since I moved a lot of code around.

bors · 2026-01-07T19:38:11Z

☔ The latest upstream changes (presumably #150645) made this pull request unmergeable. Please resolve the merge conflicts.

rust-bors · 2026-01-07T19:43:43Z

☔ The latest upstream changes (presumably #150645) made this pull request unmergeable. Please resolve the merge conflicts.

Previously, these failed to resolve, despite them working for struct fields or enum variants that were behind aliases. However, there is now an inconsistency where enum variant fields behind an alias resolve to the entry on the alias's page, while enum variants and struct fields resolve to the page of the backing ADT.

The old name and API were confusing. In my opinion, looking up the type at the call site is clearer.

All the other parts of this function return the Res for the containing page, but for some reason, this returns the associated item itself. It doesn't seem to affect the behavior of rustdoc because e.g. the href functions use the parent if the DefId is for an assoc item. But it's clearer and simpler to be consistent.

camelid · 2026-01-08T21:14:00Z

Ok, I think this is ready for review now. It doesn't fix all the inconsistencies with type aliases and associated items, but it does improve the status quo and adds some tests so we'll notice if/when we change things.

The rules around when impls from an aliased type are inlined into the alias's docs seem pretty arbitrary and inconsistent, so we should probably nail that down before we adjust where intra-doc links go.

GuillaumeGomez · 2026-01-09T15:06:23Z

src/librustdoc/passes/collect_intra_doc_links.rs

+        }
+
+        let search_for_field = || {
+            let (DefKind::Struct | DefKind::Union) = adt_def_kind else { return vec![] };


Doesn't work for enum's variants with fields I guess?

That's handled separately in the variant_field function. The reason there's a distinction is that paths to struct and union fields look the same as paths to enum variants and associated items (two segments), while paths to enum variant fields look different (three segments).

I agree that it's confusing that they're handled separately though. I think it would be simpler if we don't do this sort of path length-based separation.

It looks like this length-based logic means that re-exports of variants don't work properly (can't look up their fields). Although this is a pre-existing bug, we should definitely try to fix it in a future PR.

Please open an issue. :)

GuillaumeGomez

Looks good to me, thanks! Just one question but otherwise seems ready to go.

View changes since this review

camelid · 2026-01-12T20:49:02Z

@bors r=GuillaumeGomez

rust-bors · 2026-01-12T20:49:05Z

📌 Commit 2b618ed has been approved by GuillaumeGomez

It is now in the queue for this repository.

@GuillaumeGomez

…Gomez rustdoc: Fix intra-doc link bugs involving type aliases and associated items This PR: - Add support for linking to fields of variants behind a type alias. - Correctly resolve links to fields and variants behind a type alias to the alias's version of the docs. - Refactor some intra-doc links code to make it simpler. - Add tests for the status quo of linking to associated items behind aliases. Future steps: - Nail down the rules of when inherent and trait impls are inlined into an alias's docs, and when impls on the alias appear for the aliased type. - Adjust the resolutions of intra-doc links, through aliases, to associated items based on these rules. r? @GuillaumeGomez

@ghost

…uwer Rollup of 13 pull requests Successful merges: - #150586 (rustdoc: Fix intra-doc link bugs involving type aliases and associated items) - #150677 (Improve std::path::Path::join documentation) - #150723 (std: move `errno` and related functions into `sys::io`) - #150737 (diagnostics: make implicit Sized bounds explicit in E0277) - #150771 (Remove legacy homu `try` and `auto` branch mentions) - #150915 (Regression test for type params on eii) - #150962 (Remove `FeedConstTy` and provide ty when lowering const arg) - #151017 (Port the rustc dump attributes to the attribute parser) - #151019 (Make `Type::of` support unsized types) - #151034 (std: Change UEFI env vars to volatile storage) - #151052 (ui: add regression test for macro resolution ICE (issue #150711)) - #151053 (Reduce flakyness for `tests/rustdoc-gui/notable-trait.goml`) - #151055 (Emit error instead of delayed bug when meeting mismatch type for const array) r? @ghost

GuillaumeGomez · 2026-01-13T22:38:15Z

I think this is the one which failed in #151070 (if I'm wrong please re-r+ it and sorry for the noise).

@bors r-

rust-bors · 2026-01-13T22:38:21Z

Commit 2b618ed has been unapproved.

JonathanBrouwer · 2026-01-14T10:07:41Z

A rollup failed with the same error again, so this was probably incorrectly r-'ed
If this try job succeeds feel free to r+ again
@bors try jobs=dist-x86_64-linux-alt

rustdoc: Fix intra-doc link bugs involving type aliases and associated items try-job: dist-x86_64-linux-alt

rust-bors · 2026-01-14T12:34:49Z

☀️ Try build successful (CI)
Build commit: 81367f2 (81367f222ae78ecdc58ce30bbe8de8f5887d2f68, parent: 4931e09e3ac3182d2a00f38cccfdf68e8e385e1c)

JonathanBrouwer · 2026-01-14T12:39:26Z

@bors r=GuillaumeGomez

rust-bors · 2026-01-14T12:39:31Z

📌 Commit 2b618ed has been approved by GuillaumeGomez

It is now in the queue for this repository.

@GuillaumeGomez

…Gomez rustdoc: Fix intra-doc link bugs involving type aliases and associated items This PR: - Add support for linking to fields of variants behind a type alias. - Correctly resolve links to fields and variants behind a type alias to the alias's version of the docs. - Refactor some intra-doc links code to make it simpler. - Add tests for the status quo of linking to associated items behind aliases. Future steps: - Nail down the rules of when inherent and trait impls are inlined into an alias's docs, and when impls on the alias appear for the aliased type. - Adjust the resolutions of intra-doc links, through aliases, to associated items based on these rules. r? @GuillaumeGomez

@GuillaumeGomez

…Gomez rustdoc: Fix intra-doc link bugs involving type aliases and associated items This PR: - Add support for linking to fields of variants behind a type alias. - Correctly resolve links to fields and variants behind a type alias to the alias's version of the docs. - Refactor some intra-doc links code to make it simpler. - Add tests for the status quo of linking to associated items behind aliases. Future steps: - Nail down the rules of when inherent and trait impls are inlined into an alias's docs, and when impls on the alias appear for the aliased type. - Adjust the resolutions of intra-doc links, through aliases, to associated items based on these rules. r? @GuillaumeGomez

@ghost

…uwer Rollup of 12 pull requests Successful merges: - #150585 (Add a context-consistency check before emitting redundant generic-argument suggestions) - #150586 (rustdoc: Fix intra-doc link bugs involving type aliases and associated items) - #150590 (Don't try to recover keyword as non-keyword identifier ) - #150817 (cleanup: remove borrowck handling for inline const patterns) - #150939 (resolve: Relax some asserts in glob overwriting and add tests) - #150966 (rustc_target: Remove unused Arch::PowerPC64LE) - #150971 (Disallow eii in statement position) - #151016 (fix: WASI threading regression by disabling pthread usage) - #151046 (compiler: Make Externally Implementable Item (eii) macros "semiopaque") - #151103 (mir_build: Simplify length-determination and indexing for array/slice patterns) - #151117 (Avoid serde dependency in build_helper when not necessary) - #151127 (Delete `MetaItemOrLitParser::Err`) r? @ghost

@GuillaumeGomez

…Gomez rustdoc: Fix intra-doc link bugs involving type aliases and associated items This PR: - Add support for linking to fields of variants behind a type alias. - Correctly resolve links to fields and variants behind a type alias to the alias's version of the docs. - Refactor some intra-doc links code to make it simpler. - Add tests for the status quo of linking to associated items behind aliases. Future steps: - Nail down the rules of when inherent and trait impls are inlined into an alias's docs, and when impls on the alias appear for the aliased type. - Adjust the resolutions of intra-doc links, through aliases, to associated items based on these rules. r? @GuillaumeGomez

@ghost

…uwer Rollup of 16 pull requests Successful merges: - #150585 (Add a context-consistency check before emitting redundant generic-argument suggestions) - #150586 (rustdoc: Fix intra-doc link bugs involving type aliases and associated items) - #150590 (Don't try to recover keyword as non-keyword identifier ) - #150817 (cleanup: remove borrowck handling for inline const patterns) - #150939 (resolve: Relax some asserts in glob overwriting and add tests) - #150962 (Remove `FeedConstTy` and provide ty when lowering const arg) - #150966 (rustc_target: Remove unused Arch::PowerPC64LE) - #150971 (Disallow eii in statement position) - #151016 (fix: WASI threading regression by disabling pthread usage) - #151046 (compiler: Make Externally Implementable Item (eii) macros "semiopaque") - #151099 (Recover parse gracefully from `<const N>`) - #151117 (Avoid serde dependency in build_helper when not necessary) - #151127 (Delete `MetaItemOrLitParser::Err`) - #151128 (Add temporary new bors e-mail address to the mailmap) - #151130 (resolve: Downgrade `ambiguous_glob_imports` to warn-by-default) - #151138 (Rename `rust.use-lld` to `rust.bootstrap-override-lld` in INSTALL.md) r? @ghost

@ghost

…uwer Rollup of 15 pull requests Successful merges: - #150585 (Add a context-consistency check before emitting redundant generic-argument suggestions) - #150586 (rustdoc: Fix intra-doc link bugs involving type aliases and associated items) - #150590 (Don't try to recover keyword as non-keyword identifier ) - #150817 (cleanup: remove borrowck handling for inline const patterns) - #150939 (resolve: Relax some asserts in glob overwriting and add tests) - #150962 (Remove `FeedConstTy` and provide ty when lowering const arg) - #150966 (rustc_target: Remove unused Arch::PowerPC64LE) - #150971 (Disallow eii in statement position) - #151016 (fix: WASI threading regression by disabling pthread usage) - #151046 (compiler: Make Externally Implementable Item (eii) macros "semiopaque") - #151099 (Recover parse gracefully from `<const N>`) - #151117 (Avoid serde dependency in build_helper when not necessary) - #151127 (Delete `MetaItemOrLitParser::Err`) - #151128 (Add temporary new bors e-mail address to the mailmap) - #151138 (Rename `rust.use-lld` to `rust.bootstrap-override-lld` in INSTALL.md) r? @ghost

@GuillaumeGomez

Rollup merge of #150586 - intra-doc-assoc-alias, r=GuillaumeGomez rustdoc: Fix intra-doc link bugs involving type aliases and associated items This PR: - Add support for linking to fields of variants behind a type alias. - Correctly resolve links to fields and variants behind a type alias to the alias's version of the docs. - Refactor some intra-doc links code to make it simpler. - Add tests for the status quo of linking to associated items behind aliases. Future steps: - Nail down the rules of when inherent and trait impls are inlined into an alias's docs, and when impls on the alias appear for the aliased type. - Adjust the resolutions of intra-doc links, through aliases, to associated items based on these rules. r? @GuillaumeGomez

@ghost

…uwer Rollup of 15 pull requests Successful merges: - rust-lang/rust#150585 (Add a context-consistency check before emitting redundant generic-argument suggestions) - rust-lang/rust#150586 (rustdoc: Fix intra-doc link bugs involving type aliases and associated items) - rust-lang/rust#150590 (Don't try to recover keyword as non-keyword identifier ) - rust-lang/rust#150817 (cleanup: remove borrowck handling for inline const patterns) - rust-lang/rust#150939 (resolve: Relax some asserts in glob overwriting and add tests) - rust-lang/rust#150962 (Remove `FeedConstTy` and provide ty when lowering const arg) - rust-lang/rust#150966 (rustc_target: Remove unused Arch::PowerPC64LE) - rust-lang/rust#150971 (Disallow eii in statement position) - rust-lang/rust#151016 (fix: WASI threading regression by disabling pthread usage) - rust-lang/rust#151046 (compiler: Make Externally Implementable Item (eii) macros "semiopaque") - rust-lang/rust#151099 (Recover parse gracefully from `<const N>`) - rust-lang/rust#151117 (Avoid serde dependency in build_helper when not necessary) - rust-lang/rust#151127 (Delete `MetaItemOrLitParser::Err`) - rust-lang/rust#151128 (Add temporary new bors e-mail address to the mailmap) - rust-lang/rust#151138 (Rename `rust.use-lld` to `rust.bootstrap-override-lld` in INSTALL.md) r? @ghost

rustbot assigned GuillaumeGomez Jan 2, 2026

camelid added 5 commits January 8, 2026 11:19

rustdoc: Refactor def_id_to_res as ty_to_res

a90e041

The old name and API were confusing. In my opinion, looking up the type at the call site is clearer.

rustdoc: Extract helper function for resolving assoc items on ADTs

f503b89

Refactor out many free functions from intra-doc link code

2c98517

camelid force-pushed the intra-doc-assoc-alias branch 2 times, most recently from 2bd0b56 to 844ae64 Compare January 8, 2026 21:12

camelid marked this pull request as ready for review January 8, 2026 21:12

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Jan 8, 2026

This comment has been minimized.

Sign in to view

rustdoc: Correctly resolve variant and struct fields on alias

2b618ed

camelid force-pushed the intra-doc-assoc-alias branch from 844ae64 to 2b618ed Compare January 8, 2026 21:42

GuillaumeGomez reviewed Jan 9, 2026

View reviewed changes

GuillaumeGomez approved these changes Jan 9, 2026

View reviewed changes

rust-bors bot added the S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. label Jan 12, 2026

rust-bors bot removed the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jan 12, 2026

camelid mentioned this pull request Jan 12, 2026

rustdoc: Parse intra-doc links using rustc_parse #151030

Open

JonathanBrouwer mentioned this pull request Jan 13, 2026

Rollup of 14 pull requests #151062

Closed

JonathanBrouwer mentioned this pull request Jan 13, 2026

Rollup of 13 pull requests #151070

Closed

rust-bors bot added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Jan 13, 2026

This comment has been minimized.

Sign in to view

rust-bors bot pushed a commit that referenced this pull request Jan 14, 2026

Auto merge of #150586 - camelid:intra-doc-assoc-alias, r=<try>

81367f2

rustdoc: Fix intra-doc link bugs involving type aliases and associated items try-job: dist-x86_64-linux-alt

rust-bors bot added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Jan 14, 2026

JonathanBrouwer mentioned this pull request Jan 14, 2026

Rollup of 10 pull requests #151125

Closed

JonathanBrouwer mentioned this pull request Jan 14, 2026

Rollup of 12 pull requests #151129

Closed

JonathanBrouwer mentioned this pull request Jan 14, 2026

Rollup of 16 pull requests #151139

Closed

JonathanBrouwer mentioned this pull request Jan 14, 2026

Rollup of 15 pull requests #151144

Merged

rust-bors bot merged commit e04af73 into rust-lang:main Jan 15, 2026
12 checks passed

rustbot added this to the 1.94.0 milestone Jan 15, 2026

Uh oh!

rustdoc: Fix intra-doc link bugs involving type aliases and associated items #150586

rustdoc: Fix intra-doc link bugs involving type aliases and associated items #150586

Conversation

camelid commented Jan 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

GuillaumeGomez commented Jan 2, 2026

Uh oh!

camelid commented Jan 2, 2026

Uh oh!

camelid commented Jan 2, 2026

Uh oh!

bors commented Jan 7, 2026

Uh oh!

rust-bors bot commented Jan 7, 2026

Uh oh!

camelid commented Jan 8, 2026

Uh oh!

This comment has been minimized.

GuillaumeGomez Jan 9, 2026

Choose a reason for hiding this comment

Uh oh!

camelid Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

camelid Jan 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

GuillaumeGomez Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

GuillaumeGomez left a comment • edited by rustbot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

camelid commented Jan 12, 2026

Uh oh!

rust-bors bot commented Jan 12, 2026

Uh oh!

GuillaumeGomez commented Jan 13, 2026

Uh oh!

rust-bors bot commented Jan 13, 2026

Uh oh!

JonathanBrouwer commented Jan 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment has been minimized.

rust-bors bot commented Jan 14, 2026

Uh oh!

JonathanBrouwer commented Jan 14, 2026

Uh oh!

rust-bors bot commented Jan 14, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

camelid commented Jan 2, 2026 •

edited

Loading

camelid Jan 12, 2026 •

edited

Loading

GuillaumeGomez left a comment •

edited by rustbot

Loading

JonathanBrouwer commented Jan 14, 2026 •

edited

Loading