rustdoc: quality of life changes #148466

liigo · 2025-11-04T09:35:35Z

Support = shortcut (alongside +) to expand all sections. Already support s and S, Shift or not.
~~Fix search-input's placeholder. The input is auto focused, any key press will be accepted as input not shortcut, current placeholder is missleading.~~

rustbot · 2025-11-04T09:35:38Z

Some changes occurred in HTML/CSS/JS.

cc @GuillaumeGomez, @jsha, @lolbinarycat

rustbot · 2025-11-04T09:35:41Z

rustbot has assigned @notriddle.
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

GuillaumeGomez · 2025-11-04T09:56:45Z

src/librustdoc/html/static/js/main.js

                            autocomplete="off"
                            spellcheck="false"
-                            placeholder="Type ‘S’ or ‘/’ to search, ‘?’ for more options…"
+                            placeholder="Search API docs"


I'd prefer to keep it as is until we come up with a solution on how to tell people that this shortcut exists.

Already told to people by help button.

I don't think the current placeholder is a good idea at all.

It's shown auto-focused, which is confusing just like liigo says.

It's telling you how to open search mode after search mode is already open, which is too late to be useful.

In other words, I agree with the change in this PR.

Discovering a shortcut while using a feature is better than hiding it all the time. The help menu is not a good place to discover shortcuts sadly. Also, when the input is focused, as long as it's empty, the placeholder is displayed (at least on firefox).

This issue still remains though.

The issue metioned by @GuillaumeGomez exists and could be improved in later PR, without necessarily blocking this PR.

Then revert this change and I'll r+ the PR.

GuillaumeGomez · 2025-11-04T09:57:24Z

src/librustdoc/html/static/js/main.js

            ["← / →", "Switch result tab (when results focused)"],
            ["&#9166;", "Go to active search result"],
-            ["+", "Expand all sections"],
+            ["+ / =", "Expand all sections"],


We generally avoid adding new shortcuts to not overwrite existing browser/user's shortcuts.

the current + shortcut is not just only +, it's really shift+=.

User press - (no shift needed), it works. But if he press + (without shift), it not works, this is a bit weird, or not convenient.

It works with just + for me without shift.

That's not the case for me on firefox, what browser and keyboard layout are you using?

qwerty and firefox

Very strange, that's the same here, you don't happen to have any extensions or userscripts that could be changing that behavior, do you?

What's your exact browser version?

Only adblock. Version 143.0.3.

Ah ok, I understand the issue now. It's because I use the numpad. Well I guess = is fine then.

liigo · 2025-11-08T08:22:35Z

r? @notriddle @GuillaumeGomez

rustbot · 2025-11-08T08:22:37Z

Requested reviewer is already assigned to this pull request.

Please choose another assignee.

GuillaumeGomez · 2025-11-11T10:05:42Z

Please squash your commits then r+ time.

Essentially, `=` is "`+` without shift". Current `+` shortcut requires an extra `shift`, unless you use numpad `+`.

liigo · 2025-11-12T06:45:56Z

r? @GuillaumeGomez

GuillaumeGomez · 2025-11-12T10:52:34Z

Thanks!

@bors r+ rollup

bors · 2025-11-12T10:52:37Z

📌 Commit 9f3d84b has been approved by GuillaumeGomez

It is now in the queue for this repository.

bors · 2025-11-12T10:58:52Z

⌛ Testing commit 9f3d84b with merge 2fcbda6...

bors · 2025-11-12T14:10:52Z

☀️ Test successful - checks-actions
Approved by: GuillaumeGomez
Pushing 2fcbda6 to main...

github-actions · 2025-11-12T14:14:19Z

What is this?

This is an experimental post-merge analysis report that shows differences in test outcomes between the merged PR and its parent PR.

Comparing 95aeb46 (parent) -> 2fcbda6 (this PR)

Test differences

Show 1 test diff

1 doctest diff were found. These are ignored, as they are noisy.

Test dashboard

Run

cargo run --manifest-path src/ci/citool/Cargo.toml -- \
    test-dashboard 2fcbda6c1a70606bdb09857e01d01fc6229da712 --output-dir test-dashboard

And then open test-dashboard/index.html in your browser to see an overview of all executed tests.

Job duration changes

aarch64-apple: 6779.1s -> 9564.5s (+41.1%)
dist-apple-various: 4011.5s -> 4869.5s (+21.4%)
aarch64-msvc-2: 4763.2s -> 5620.6s (+18.0%)
x86_64-gnu-aux: 5756.6s -> 6675.7s (+16.0%)
dist-x86_64-apple: 7691.1s -> 8859.0s (+15.2%)
x86_64-msvc-2: 7374.2s -> 6402.0s (-13.2%)
x86_64-gnu-stable: 8033.5s -> 7092.7s (-11.7%)
x86_64-gnu-llvm-21-2: 5139.3s -> 5666.5s (+10.3%)
dist-powerpc64le-linux-gnu: 5103.1s -> 5596.4s (+9.7%)
i686-msvc-2: 8373.3s -> 7708.4s (-7.9%)

How to interpret the job duration changes?

Job durations can vary a lot, based on the actual runner instance
that executed the job, system noise, invalidated caches, etc. The table above is provided
mostly for t-infra members, for simpler debugging of potential CI slow-downs.

rust-timer · 2025-11-12T16:46:51Z

Finished benchmarking commit (2fcbda6): comparison URL.

Overall result: no relevant changes - no action needed

@rustbot label: -perf-regression

Instruction count

This benchmark run did not return any relevant results for this metric.

Max RSS (memory usage)

Results (primary 1.7%)

A less reliable metric. May be of interest, but not used to determine the overall result above.

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

Cycles

Results (secondary 3.7%)

A less reliable metric. May be of interest, but not used to determine the overall result above.

	mean	range	count
Regressions ❌ (primary)	-	-	0
Regressions ❌ (secondary)	3.7%	[3.5%, 3.8%]	2
Improvements ✅ (primary)	-	-	0
Improvements ✅ (secondary)	-	-	0
All ❌✅ (primary)	-	-	0

Binary size

This benchmark run did not return any relevant results for this metric.

Bootstrap: 474.976s -> 474.886s (-0.02%)
Artifact size: 391.06 MiB -> 391.10 MiB (0.01%)

rustbot assigned notriddle Nov 4, 2025

GuillaumeGomez reviewed Nov 4, 2025

View reviewed changes

rustdoc: add = shortcut to expand all sections.

9f3d84b

Essentially, `=` is "`+` without shift". Current `+` shortcut requires an extra `shift`, unless you use numpad `+`.

liigo force-pushed the better-rustdoc branch from 995675b to 9f3d84b Compare November 12, 2025 06:43

rustbot assigned GuillaumeGomez and unassigned notriddle Nov 12, 2025

GuillaumeGomez approved these changes Nov 12, 2025

View reviewed changes

bors 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-review Status: Awaiting review from the assignee but also interested parties. labels Nov 12, 2025

bors added the merged-by-bors This PR was explicitly merged by bors. label Nov 12, 2025

bors merged commit 2fcbda6 into rust-lang:main Nov 12, 2025
12 checks passed

rustbot added this to the 1.93.0 milestone Nov 12, 2025

liigo deleted the better-rustdoc branch November 13, 2025 03:31

rustdoc: quality of life changes #148466

rustdoc: quality of life changes #148466

Conversation

liigo commented Nov 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rustbot commented Nov 4, 2025

Uh oh!

rustbot commented Nov 4, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

notriddle Nov 5, 2025 • 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lolbinarycat Nov 5, 2025 • 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

liigo commented Nov 8, 2025

Uh oh!

rustbot commented Nov 8, 2025

Uh oh!

GuillaumeGomez commented Nov 11, 2025

Uh oh!

liigo commented Nov 12, 2025

Uh oh!

GuillaumeGomez commented Nov 12, 2025

Uh oh!

bors commented Nov 12, 2025

Uh oh!

bors commented Nov 12, 2025

Uh oh!

bors commented Nov 12, 2025

Uh oh!

Uh oh!

github-actions bot commented Nov 12, 2025

Test differences

Job duration changes

Uh oh!

rust-timer commented Nov 12, 2025

Overall result: no relevant changes - no action needed

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

liigo commented Nov 4, 2025 •

edited

Loading

notriddle Nov 5, 2025 •

edited

Loading

lolbinarycat Nov 5, 2025 •

edited

Loading