Add new "hide deprecated items" setting in rustdoc #151091

GuillaumeGomez · 2026-01-13T23:52:23Z

This PR adds a new JS setting which allows the JS to hide deprecated items. This is especially useful for crates like std which accumulates deprecated items but never removes them.

Nicely enough, the "deprecation" information was already in the search index, meaning I didn't need to change anything there. Before this PR, it was only used to make the deprecated items rank lower. Well now it's also used to generate an extra CSS class, allowing the JS setting to work.

This is taking over #149551.

This feature got approved by the rustdoc team in the meeting of december.

You can give it a try here.

r? @lolbinarycat

rustbot · 2026-01-13T23:52:26Z

Some changes occurred in HTML/CSS/JS.

cc @lolbinarycat

GuillaumeGomez · 2026-01-14T13:55:34Z

Rebased so it includes #151053, which hopefully should fix the flakyness issue.

lolbinarycat · 2026-01-14T19:11:00Z

This made me realize that we use the word "hide" inconsistently in this settings panel, sometimes we mean "collapse, with a button to expand it again", and sometimes we mean "act like it doesn't exist at all".

I think the former should be referred to with the verb "Collapse", I think that would make things seem a bit less inconsistent.

lolbinarycat

Logic looks sound, but there's a bunch of stuff that I think could be written either more readably or more compactly, and there's a few more test cases I would like to see.

View changes since this review

src/librustdoc/html/render/mod.rs

src/librustdoc/html/render/print_item.rs

src/librustdoc/html/static/js/storage.js

src/librustdoc/html/static/js/settings.js

tests/rustdoc-gui/src/lib2/lib.rs

tests/rustdoc-gui/setting-hide-deprecated.goml

tests/rustdoc-gui/utils.goml

lolbinarycat · 2026-01-14T19:47:08Z

@rustbot author

rustbot · 2026-01-14T21:36:04Z

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-01-16T15:28:50Z

@rustbot ready

lolbinarycat

Code looks much better (better than what I would've written, even), but I'm still not 100% satisfied with the tests.

View changes since this review

src/librustdoc/html/static/css/rustdoc.css

tests/rustdoc-gui/src/lib2/lib.rs

tests/rustdoc-gui/setting-hide-deprecated.goml

GuillaumeGomez · 2026-01-17T16:21:52Z

Applied parts of the suggestions.

…ng is working as expected

… setting, allowing to simplify JS code

lolbinarycat · 2026-01-19T21:34:00Z

One final bit of test coverage I would like to see: when searching future_deprecated_fn with "Hide deprecated items" enabled, it should not be hidden. It's a small thing, but it would be nice to make sure the handling of items with pending deprecation has consistency across search and non-search contexts.

… value in the end, no need to keep it around. Also: takes into account "is_in_effect"

Improve the `perform-search` goml function to work when search is already open

lolbinarycat · 2026-01-19T23:17:11Z

Thanks!

@bors r+

rust-bors · 2026-01-19T23:17:13Z

📌 Commit aef8112 has been approved by lolbinarycat

It is now in the queue for this repository.

@lolbinarycat

Add new "hide deprecated items" setting in rustdoc This PR adds a new JS setting which allows the JS to hide deprecated items. This is especially useful for crates like `std` which accumulates deprecated items but never removes them. Nicely enough, the "deprecation" information was already in the search index, meaning I didn't need to change anything there. Before this PR, it was only used to make the deprecated items rank lower. Well now it's also used to generate an extra CSS class, allowing the JS setting to work. This is taking over rust-lang#149551. This feature got approved by the rustdoc team in the [meeting of december](https://rust-lang.zulipchat.com/#narrow/channel/393423-t-rustdoc.2Fmeetings/topic/2025-12-08/near/562553156). You can give it a try [here](https://rustdoc.crud.net/imperio/hide-deprecated-items/foo/index.html). r? @lolbinarycat

@ghost

Rollup of 8 pull requests Successful merges: - #149587 (coverage: Sort the expansion tree to help choose a single BCB for child expansions) - #150071 (Add dist step for Enzyme) - #150288 (Add scalar support for offload) - #151091 (Add new "hide deprecated items" setting in rustdoc) - #151255 (rustdoc: Fix ICE when deprecated note is not resolved on the correct `DefId`) - #151375 (Fix terminal width dependent tests) - #151384 (add basic `TokenStream` api tests) - #151391 (rustc-dev-guide subtree update) r? @ghost

@lolbinarycat

Rollup merge of #151091 - hide-deprecated-items, r=lolbinarycat Add new "hide deprecated items" setting in rustdoc This PR adds a new JS setting which allows the JS to hide deprecated items. This is especially useful for crates like `std` which accumulates deprecated items but never removes them. Nicely enough, the "deprecation" information was already in the search index, meaning I didn't need to change anything there. Before this PR, it was only used to make the deprecated items rank lower. Well now it's also used to generate an extra CSS class, allowing the JS setting to work. This is taking over #149551. This feature got approved by the rustdoc team in the [meeting of december](https://rust-lang.zulipchat.com/#narrow/channel/393423-t-rustdoc.2Fmeetings/topic/2025-12-08/near/562553156). You can give it a try [here](https://rustdoc.crud.net/imperio/hide-deprecated-items/foo/index.html). r? @lolbinarycat

GuillaumeGomez · 2026-01-20T13:09:31Z

Thanks to this check, I discovered that the IndexItem::deprecation field for the search items didn't check for is_in_effect, so I reworked it a bit: now it's a boolean and it uses the Item::is_deprecated method instead, which does check for is_in_effect.

@ghost

Rollup of 8 pull requests Successful merges: - rust-lang/rust#149587 (coverage: Sort the expansion tree to help choose a single BCB for child expansions) - rust-lang/rust#150071 (Add dist step for Enzyme) - rust-lang/rust#150288 (Add scalar support for offload) - rust-lang/rust#151091 (Add new "hide deprecated items" setting in rustdoc) - rust-lang/rust#151255 (rustdoc: Fix ICE when deprecated note is not resolved on the correct `DefId`) - rust-lang/rust#151375 (Fix terminal width dependent tests) - rust-lang/rust#151384 (add basic `TokenStream` api tests) - rust-lang/rust#151391 (rustc-dev-guide subtree update) r? @ghost

Zalathar · 2026-01-21T03:13:53Z

Be advised of some doc perf regressions in rollup:

Rollup of 8 pull requests #151395 (comment)

rustbot assigned lolbinarycat Jan 13, 2026

GuillaumeGomez mentioned this pull request Jan 13, 2026

Add flag to exclude deprecated items in rustdoc #149551

Closed

This comment has been minimized.

Sign in to view

GuillaumeGomez force-pushed the hide-deprecated-items branch 2 times, most recently from 1fe45dd to 4622f64 Compare January 14, 2026 13:54

rustbot added the A-rustdoc-js Area: Rustdoc's JS front-end label Jan 14, 2026

This comment has been minimized.

Sign in to view

lolbinarycat added the relnotes Marks issues that should be documented in the release notes of the next release. label Jan 14, 2026

rustbot mentioned this pull request Jan 14, 2026

Tracking issue for release notes of #151091: Add new "hide deprecated items" setting in rustdoc #151133

Open

lolbinarycat reviewed Jan 14, 2026

View reviewed changes

rustbot 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-review Status: Awaiting review from the assignee but also interested parties. labels Jan 14, 2026

Add new "hide deprecated items" setting in rustdoc

4ded639

GuillaumeGomez force-pushed the hide-deprecated-items branch from 4622f64 to 33bbf06 Compare January 14, 2026 21:36

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 16, 2026

lolbinarycat reviewed Jan 16, 2026

View reviewed changes

GuillaumeGomez force-pushed the hide-deprecated-items branch from 33bbf06 to 893a742 Compare January 17, 2026 16:21

GuillaumeGomez added 3 commits January 19, 2026 21:37

Add rustdoc GUI test to ensure that the "hide deprecated items" setti…

9f965bc

…ng is working as expected

Improve JS source code for settings

5561167

Rename sans-serif CSS class into sans-serif-fonts to match the JS…

bf49068

… setting, allowing to simplify JS code

GuillaumeGomez force-pushed the hide-deprecated-items branch from 893a742 to bf49068 Compare January 19, 2026 20:37

GuillaumeGomez added 2 commits January 19, 2026 23:10

Simplify IndexItem::deprecation field: since we only need a boolean…

9e5e432

… value in the end, no need to keep it around. Also: takes into account "is_in_effect"

Add test for search results of not yet deprecated search items

aef8112

Improve the `perform-search` goml function to work when search is already open

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-review Status: Awaiting review from the assignee but also interested parties. labels Jan 19, 2026

This was referenced Jan 20, 2026

Rollup of 9 pull requests #151392

Closed

Rollup of 8 pull requests #151395

Merged

rust-bors bot merged commit 88df8fd into rust-lang:main Jan 20, 2026
11 checks passed

rustbot added this to the 1.95.0 milestone Jan 20, 2026

GuillaumeGomez deleted the hide-deprecated-items branch January 20, 2026 13:09

Zalathar mentioned this pull request Jan 21, 2026

rustdoc: Fix ICE when deprecated note is not resolved on the correct DefId #151255

Merged

Uh oh!

Add new "hide deprecated items" setting in rustdoc #151091

Add new "hide deprecated items" setting in rustdoc #151091

Uh oh!

Conversation

GuillaumeGomez commented Jan 13, 2026

Uh oh!

rustbot commented Jan 13, 2026

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

GuillaumeGomez commented Jan 14, 2026

Uh oh!

lolbinarycat commented Jan 14, 2026

Uh oh!

lolbinarycat 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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lolbinarycat commented Jan 14, 2026

Uh oh!

rustbot commented Jan 14, 2026

Uh oh!

GuillaumeGomez commented Jan 16, 2026

Uh oh!

lolbinarycat 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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

lolbinarycat commented Jan 19, 2026

Uh oh!

lolbinarycat commented Jan 19, 2026

Uh oh!

rust-bors bot commented Jan 19, 2026

Uh oh!

Uh oh!

GuillaumeGomez commented Jan 20, 2026

Uh oh!

Zalathar commented Jan 21, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

lolbinarycat left a comment •

edited by rustbot

Loading

lolbinarycat left a comment •

edited by rustbot

Loading

GuillaumeGomez commented Jan 17, 2026 •

edited

Loading