rustdoc: add disambiguators for identically named method in sidebar by lolbinarycat · Pull Request #162778 · rust-lang/rust

lolbinarycat · 2026-09-14T18:38:34Z

also affects associated fns. main improvments are to pointer and box docs.

before:

after:

rustbot · 2026-09-14T18:38:40Z

rustbot has assigned @GuillaumeGomez.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

Why was this reviewer chosen?

The reviewer was selected based on:

Owners of files modified in this PR: rustdoc
rustdoc expanded to 8 candidates
Random selection from GuillaumeGomez, notriddle

GuillaumeGomez · 2026-09-14T18:46:47Z

+        Cow::Borrowed(s) => *s = &s[..len],
+        Cow::Owned(s) => s.truncate(len),
+    };
+    fn get_shortname<'a>(itm: Option<&'a Link<'a>>) -> Option<&'a str> {


Just a nit:

Suggested change

fn get_shortname<'a>(itm: Option<&'a Link<'a>>) -> Option<&'a str> {

fn get_short_name<'a>(item: Option<&'a Link<'a>>) -> Option<&'a str> {

View changes since the review

GuillaumeGomez · 2026-09-14T18:47:22Z

    })
 }

+fn postprocess_method_list(ml: &mut [Link<'_>]) {


Suggested change

fn postprocess_method_list(ml: &mut [Link<'_>]) {

fn postprocess_method_list(methods: &mut [Link<'_>]) {

View changes since the review

GuillaumeGomez · 2026-09-14T18:56:51Z

+        let cur_sn = get_shortname(ml.get(i));
+        if get_shortname(ml.get(i.wrapping_sub(1))) != cur_sn
+            && cur_sn != get_shortname(ml.get(i + 1))
+        {
+            let csnl = cur_sn.unwrap().len();
+            trunc_to(&mut ml[i].name, csnl);


Bigger suggestion then:

Suggested change

let cur_sn = get_shortname(ml.get(i));

if get_shortname(ml.get(i.wrapping_sub(1))) != cur_sn

&& cur_sn != get_shortname(ml.get(i + 1))

{

let csnl = cur_sn.unwrap().len();

trunc_to(&mut ml[i].name, csnl);

let Some(short_name) = get_short_name(methods.get(i)) else { continue };

if i > 0

&& get_short_name(methods.get(i - 1)) != Some(short_name)

&& Some(short_name) != get_short_name(methods.get(i + 1))

{

let current_len = short_name.len();

trunc_to(&mut methods[i].name, current_len);

View changes since the review

lolbinarycat · 2026-09-16T17:09:53Z

the i > 0 change would break the code, as it would cause the first sidebar item to be always disambiguated.

GuillaumeGomez · 2026-09-16T18:53:06Z

I like it a lot and the implementation looks good. Now just remains to add tests. :)

GuillaumeGomez · 2026-09-21T18:42:39Z

+impl C<A> {
+    //@ has - "//a[@href='#method.dupe']" "dupe (C<A>)"
+    pub fn dupe(self) {}
+    //@ has - "//a[@href='#method.uniq1']" "uniq1"


Use matches with $ and ^ to ensure it's the full string instead of !has below.

View changes since the review

GuillaumeGomez · 2026-09-21T20:31:18Z

+pub struct C<T>(T);
+
+impl C<A> {
+    //@ has - "//a[@href='#method.dupe']" "^dupe (C<A>)$"


Shouldn't it be matches here as well?

View changes since the review

rustbot · 2026-10-15T16:21:03Z

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.

GuillaumeGomez · 2026-10-15T16:29:18Z

Nice, thanks!

@bors r+ rollup

rust-bors · 2026-10-15T16:29:22Z

📌 Commit 46fca93 has been tentatively approved by GuillaumeGomez

It will be put into the queue for this repository once PR CI succeeds.

…big-142147, r=GuillaumeGomez rustdoc: add disambiguators for identically named method in sidebar fixes rust-lang#142147 also affects associated fns. main improvments are to pointer and box docs. before: <img width="264" height="439" alt="image" src="https://github.com/user-attachments/assets/8347c2b8-88cb-470f-beb3-6cb377ca37f0" /> after: <img width="693" height="576" alt="image" src="https://github.com/user-attachments/assets/478d1ef5-7a1e-4024-a796-d2b0fd0f5a49" />

…uwer Rollup of 8 pull requests Successful merges: - #164271 (Add release notes for 1.99.1) - #164361 (delegation: map return even if there is no target expression) - #162778 (rustdoc: add disambiguators for identically named method in sidebar) - #163224 ([rustdoc] Add tabs to settings popover) - #164220 (Test the interaction between `--remap-path-prefix` and doctests) - #164279 (Make the `documentation` scope a sub-scope of the `object` scope) - #164318 (Fix check with `is_impl_trait_in_trait()` before expecting local id) - #164360 (Fix(lib/sys): Restore Win7 compilation)

…uwer Rollup of 7 pull requests Successful merges: - #164175 (Drop WC_ERR_INVALID_CHARS from Windows stdio) - #164361 (delegation: map return even if there is no target expression) - #162778 (rustdoc: add disambiguators for identically named method in sidebar) - #163224 ([rustdoc] Add tabs to settings popover) - #164220 (Test the interaction between `--remap-path-prefix` and doctests) - #164318 (Fix check with `is_impl_trait_in_trait()` before expecting local id) - #164360 (Fix(lib/sys): Restore Win7 compilation)

Rollup merge of #162778 - lolbinarycat:rustdoc-sidebar-disambig-142147, r=GuillaumeGomez rustdoc: add disambiguators for identically named method in sidebar fixes #142147 also affects associated fns. main improvments are to pointer and box docs. before: <img width="264" height="439" alt="image" src="https://github.com/user-attachments/assets/8347c2b8-88cb-470f-beb3-6cb377ca37f0" /> after: <img width="693" height="576" alt="image" src="https://github.com/user-attachments/assets/478d1ef5-7a1e-4024-a796-d2b0fd0f5a49" />

rust-timer · 2026-10-16T10:52:22Z

Note

This PR was benchmarked as part of triage of its containing rollup: triage URL.

Finished benchmarking commit (7278160): comparison URL.

Overall result: ❌ regressions - please read:

Our benchmarks found a performance regression caused by this PR.
This might be an actual regression, but it can also be just noise.

Next Steps:

If the regression was expected or you think it can be justified,
please write a comment with sufficient written justification, and add
@rustbot label: +perf-regression-triaged to it, to mark the regression as triaged.
If you think that you know of a way to resolve the regression, try to create
a new PR with a fix for the regression.
If you do not understand the regression or you think that it is just noise,
you can ask the @rust-lang/wg-compiler-performance working group for help (members of this group
were already notified of this PR).

@rustbot label: +perf-regression
cc @rust-lang/wg-compiler-performance

Instruction count

Our most reliable metric. Used to determine the overall result above. However, even this metric can be noisy.

	mean	range	count
Regressions ❌ (primary)	-	-	0
Regressions ❌ (secondary)	2.4%	[2.4%, 2.4%]	1
Improvements ✅ (primary)	-	-	0
Improvements ✅ (secondary)	-	-	0
All ❌✅ (primary)	-	-	0

Max RSS (memory usage)

This perf run didn't have relevant results for this metric.

Cycles

This perf run didn't have relevant results for this metric.

Binary size

This perf run didn't have relevant results for this metric.

Artifact size: 406.81 MiB -> 406.97 MiB (0.04%)

Mark-Simulacrum · 2026-10-20T12:34:45Z

Regression is real and persists, but limited to just one doc scenario and seems likely expected from disambiguating methods in the sidebar (more work to do, probably slightly more output).

rustbot assigned GuillaumeGomez Sep 14, 2026

GuillaumeGomez reviewed Sep 14, 2026

View reviewed changes

Comment thread src/librustdoc/html/render/sidebar.rs Outdated

GuillaumeGomez reviewed Sep 14, 2026

View reviewed changes

Comment thread src/librustdoc/html/render/sidebar.rs Outdated

GuillaumeGomez reviewed Sep 14, 2026

View reviewed changes

Comment thread src/librustdoc/html/render/sidebar.rs Outdated

GuillaumeGomez reviewed Sep 14, 2026

View reviewed changes

lolbinarycat force-pushed the rustdoc-sidebar-disambig-142147 branch from 2dd6d30 to bf8114c Compare September 16, 2026 17:08

GuillaumeGomez reviewed Sep 21, 2026

View reviewed changes

lolbinarycat force-pushed the rustdoc-sidebar-disambig-142147 branch from 8080cd8 to d8272dc Compare September 21, 2026 20:02

GuillaumeGomez reviewed Sep 21, 2026

View reviewed changes

This comment has been minimized.

Sign in to view

lolbinarycat force-pushed the rustdoc-sidebar-disambig-142147 branch from d8272dc to 976084c Compare September 22, 2026 17:52

This comment has been minimized.

Sign in to view

lolbinarycat force-pushed the rustdoc-sidebar-disambig-142147 branch from 976084c to 9bab947 Compare September 22, 2026 18:36

This comment has been minimized.

Sign in to view

lolbinarycat force-pushed the rustdoc-sidebar-disambig-142147 branch from 9bab947 to 46fca93 Compare October 15, 2026 16:20

lolbinarycat added 2 commits October 15, 2026 12:23

rustdoc: add disambiguators for identically named method in sidebar

d2e6e9e

rustdoc: add test for new sidebar disambiguators

46fca93

GuillaumeGomez approved these changes Oct 15, 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 Oct 15, 2026

rust-bors Bot removed the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Oct 15, 2026

JonathanBrouwer mentioned this pull request Oct 15, 2026

Rollup of 7 pull requests #164381

Closed

JonathanBrouwer mentioned this pull request Oct 15, 2026

Rollup of 8 pull requests #164382

Closed

JonathanBrouwer mentioned this pull request Oct 16, 2026

Rollup of 7 pull requests #164418

Merged

rust-bors Bot merged commit 3235e54 into rust-lang:main Oct 16, 2026
14 checks passed

rustbot added this to the 1.101.0 milestone Oct 16, 2026

rustbot added the perf-regression Performance regression. label Oct 16, 2026

Mark-Simulacrum added the perf-regression-triaged The performance regression has been triaged. label Oct 20, 2026

	fn get_shortname<'a>(itm: Option<&'a Link<'a>>) -> Option<&'a str> {
	fn get_short_name<'a>(item: Option<&'a Link<'a>>) -> Option<&'a str> {

	fn postprocess_method_list(ml: &mut [Link<'_>]) {
	fn postprocess_method_list(methods: &mut [Link<'_>]) {

-        let cur_sn = get_shortname(ml.get(i));
-        if get_shortname(ml.get(i.wrapping_sub(1))) != cur_sn
-            && cur_sn != get_shortname(ml.get(i + 1))
-        {
-            let csnl = cur_sn.unwrap().len();
-            trunc_to(&mut ml[i].name, csnl);
+        let Some(short_name) = get_short_name(methods.get(i)) else { continue };
+        if i > 0
+            && get_short_name(methods.get(i - 1)) != Some(short_name)
+            && Some(short_name) != get_short_name(methods.get(i + 1))
+        {
+            let current_len = short_name.len();
+            trunc_to(&mut methods[i].name, current_len);

Conversation

lolbinarycat commented Sep 14, 2026 • edited by rustbot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rustbot commented Sep 14, 2026

Uh oh!

GuillaumeGomez Sep 14, 2026 • 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!

GuillaumeGomez Sep 14, 2026 • 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!

Uh oh!

Uh oh!

Uh oh!

GuillaumeGomez Sep 14, 2026 • 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!

lolbinarycat commented Sep 16, 2026

Uh oh!

GuillaumeGomez commented Sep 16, 2026

Uh oh!

GuillaumeGomez Sep 21, 2026 • 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!

GuillaumeGomez Sep 21, 2026 • 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!

lolbinarycat Sep 21, 2026

Choose a reason for hiding this comment

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

rustbot commented Oct 15, 2026

Uh oh!

GuillaumeGomez commented Oct 15, 2026

Uh oh!

rust-bors Bot commented Oct 15, 2026

Uh oh!

Uh oh!

rust-timer commented Oct 16, 2026

Overall result: ❌ regressions - please read:

Instruction count

Max RSS (memory usage)

Cycles

Binary size

Uh oh!

Mark-Simulacrum commented Oct 20, 2026

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

lolbinarycat commented Sep 14, 2026 •

edited by rustbot

Loading

GuillaumeGomez Sep 14, 2026 •

edited by rustbot

Loading

GuillaumeGomez Sep 14, 2026 •

edited by rustbot

Loading

GuillaumeGomez Sep 14, 2026 •

edited by rustbot

Loading

GuillaumeGomez Sep 21, 2026 •

edited by rustbot

Loading

GuillaumeGomez Sep 21, 2026 •

edited by rustbot

Loading