[rustdoc] Only generate search DOM elements if the search is actually needed - #160639
Merged
Conversation
Collaborator
|
Some changes occurred in HTML/CSS/JS. |
rustbot
added
A-rustdoc-js
GuillaumeGomez
commented
Aug 6, 2026
| @@ -16,6 +17,7 @@ define-function: ("collapsed-from-search", [], block { | |||
| // Then we collapse the section again... | |||
| set-property: ("#implementations-list .implementors-toggle", {"open": "false"}) | |||
| // Then we run the search. | |||
| call-function: ("open-search", {}) | |||
Member
Author
There was a problem hiding this comment.
Ah that was my original "quest": looking at fixing the new flakyness which happened in #159593 (comment). ^^'
GuillaumeGomez
commented
Aug 6, 2026
This comment has been minimized.
This comment has been minimized.
GuillaumeGomez
force-pushed
the
search-dom
branch
from
August 6, 2026 14:07
24284c5 to
977669b
Compare
Member
Author
|
Added the missing Typescript type definition update and CI is now happy. |
Member
Author
|
Added comments as suggested for clarification. |
Comment on lines
+250
to
+251
| // If you're browsing the nightly docs, the page might need to be refreshed for | ||
| // the search to work because the hash of the JS scripts might have changed. |
Contributor
There was a problem hiding this comment.
nit: technically this doesn't just apply to nightly, it's just way more common there
Comment on lines
+261
to
+269
| if (!window.StringdexOnload) { | ||
| window.StringdexOnload = []; | ||
| } | ||
| window.StringdexOnload.push(() => { | ||
| loadScript( | ||
| getVar("static-root-path") + getVar("search-js"), | ||
| sendSearchForm, | ||
| ); | ||
| }); |
Contributor
There was a problem hiding this comment.
the structure of this doesn't make a ton of sense to me in combination, shouldn't we just be initializing it to an array with a single element? otherwise we could hypothetically end up with an array of duplicate initializers?
Member
Author
There was a problem hiding this comment.
Just moved existing code, didn't modify anything. I think it's because you can have multiple search indexes loaded in parallel.
Comment on lines
+503
to
+504
| // We load the search input. | ||
| window.searchState.inputElement(); |
Contributor
There was a problem hiding this comment.
best i can tell, inputElement() doesn't directly load the search, it sets up a focus handler that loads the search.. why not just load the search and get something more readable and less indirect?
Member
Author
There was a problem hiding this comment.
I'll improve the comment as it's quite unclear.
GuillaumeGomez
force-pushed
the
search-dom
branch
from
August 12, 2026 20:51
3367289 to
730e9a6
Compare
Member
Author
|
Improved the problematic comment. As I mentioned, the rest is just code I moved around. |
Contributor
|
@bors r+ |
Contributor
rust-bors
Bot
added
S-waiting-on-bors
JonathanBrouwer
added a commit
to JonathanBrouwer/rust
that referenced
this pull request
Aug 19, 2026
…narycat [rustdoc] Only generate search DOM elements if the search is actually needed I realized that we were generating the search DOM elements (everything contained into `#search`) all the times, even when there is no search query parameters in the URL. That seems unnecessary so I reworked the JS a bit to remove that. r? @lolbinarycat
JonathanBrouwer
added a commit
to JonathanBrouwer/rust
that referenced
this pull request
Aug 20, 2026
…narycat [rustdoc] Only generate search DOM elements if the search is actually needed I realized that we were generating the search DOM elements (everything contained into `#search`) all the times, even when there is no search query parameters in the URL. That seems unnecessary so I reworked the JS a bit to remove that. r? @lolbinarycat
This was referenced Aug 20, 2026
rust-bors Bot
pushed a commit
that referenced
this pull request
Aug 20, 2026
…uwer Rollup of 26 pull requests Successful merges: - #161384 (Bust sccache's cache) - #161325 (Bump bootstrap to 1.99.0-beta.1) - #161344 (Update the `rustc-perf` submodule) - #161366 (Subtree sync for rustc_codegen_cranelift) - #159071 ([PAC] Encoder and hash (1/8)) - #160639 ([rustdoc] Only generate search DOM elements if the search is actually needed) - #161068 (Ensure TLS accesses don't call the global allocator through panic (part 3) ) - #161332 (Some `GlobalCtxt`/`Session` cleanups) - #150931 (rustdoc: Always document `#[repr(transparent)]` if `#[rustc_pub_transparent]` is applied) - #158999 (doc: list all remove_dir_all fallback targets) - #160582 (Add `remove hidden_glob_reexports item breaks downstream` test) - #160876 (remove unwrap from write_mir_fn_graphviz) - #160927 (Enhance EII UI tests) - #161070 (fix arm homogeneous aggregate ABI) - #161190 (fix crash in async-drop and async-gen) - #161236 (Download auto jobs in citool in parallel) - #161254 (Reserve capacity for 3% anon nodes) - #161283 (Tighten the language used for documenting `TargetOptions::llvm_abiname`) - #161291 (Rename `ProjectionPredicate` and `TraitPredicate`) - #161293 (add relnotes 1.98.0) - #161299 (Remove a bunch of unnecessary explicit lifetimes) - #161307 (make ARM maintainers pingable) - #161308 (Add regression test for rustc diagnostic to recognize variables in match guards) - #161346 (Don't rely on std traits not being const in tests) - #161360 (vec: fixup the name that i forgot) - #161367 (Reflect current PR title names for subtree syncs in triagebot no-merges)
rust-bors Bot
pushed a commit
that referenced
this pull request
Aug 20, 2026
Rollup merge of #160639 - GuillaumeGomez:search-dom, r=lolbinarycat [rustdoc] Only generate search DOM elements if the search is actually needed I realized that we were generating the search DOM elements (everything contained into `#search`) all the times, even when there is no search query parameters in the URL. That seems unnecessary so I reworked the JS a bit to remove that. r? @lolbinarycat
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
4 participants
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 realized that we were generating the search DOM elements (everything contained into
#search) all the times, even when there is no search query parameters in the URL. That seems unnecessary so I reworked the JS a bit to remove that.r? @lolbinarycat