rustdoc: Improvements for `rustc_must_implement_one_of` by GuillaumeGomez · Pull Request #164266 · rust-lang/rust

GuillaumeGomez · 2026-10-13T14:31:19Z

Fixes #163675.

Funnily enough, most things are actually already there, so this PR is only an improvement over the following:

The methods listed in the note are now links.
The note itself got a little display improvement (unified with the existing ones mostly, screenshots below).
Added the Required Methods heading in the sidebar if rustc_must_implement_one_of is used

Before:

After:

r? @Urgau

…enerate links to the mentioned methods

…are none if the `rustc_must_implement_one_of` attribute is present

Urgau

LGTM

View changes since this review

Urgau · 2026-10-13T19:51:38Z

@bors r+ rollup

rust-bors · 2026-10-13T19:51:43Z

📌 Commit cad2ab9 has been tentatively approved by Urgau

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

@Urgau

…t_one_of, r=Urgau rustdoc: Improvements for `rustc_must_implement_one_of` Fixes rust-lang#163675. Funnily enough, most things are actually already there, so this PR is only an improvement over the following: * The methods listed in the note are now links. * The note itself got a little display improvement (unified with the existing ones mostly, screenshots below). * Added the `Required Methods` heading in the sidebar if `rustc_must_implement_one_of` is used Before: <img width="407" height="114" alt="Screenshot From 2026-10-13 16-30-39" src="https://github.com/user-attachments/assets/ccbe09bd-437a-45ab-a6ae-e77f02c68b19" /> After: <img width="454" height="121" alt="Screenshot From 2026-10-13 16-30-47" src="https://github.com/user-attachments/assets/62b4e7a7-b727-4e25-ade4-7e530fd110cb" /> r? @Urgau

Rollup of 9 pull requests Successful merges: - #162749 (Recover missing `turbofish` for `lifetime` arguments in expression position) - #164170 (Prefer WriteConsoleW for stdout on Windows) - #164255 (test DSL eagerly handle false constraints) - #163230 (Document zero-sized allocations properly for `Box` and `Vec`) - #163940 (Parse move exprs as a bottom expr instead of a prefix expr) - #164219 (Windows FileExt trait doesn't need to handle ErrorKind::Interrupted; test improvements for same) - #164220 (Test the interaction between `--remap-path-prefix` and doctests) - #164266 (rustdoc: Improvements for `rustc_must_implement_one_of`) - #164278 (Output remapped paths in rustdoc JSON with the `documentation` scope)

@Urgau

…t_one_of, r=Urgau rustdoc: Improvements for `rustc_must_implement_one_of` Fixes rust-lang#163675. Funnily enough, most things are actually already there, so this PR is only an improvement over the following: * The methods listed in the note are now links. * The note itself got a little display improvement (unified with the existing ones mostly, screenshots below). * Added the `Required Methods` heading in the sidebar if `rustc_must_implement_one_of` is used Before: <img width="407" height="114" alt="Screenshot From 2026-10-13 16-30-39" src="https://github.com/user-attachments/assets/ccbe09bd-437a-45ab-a6ae-e77f02c68b19" /> After: <img width="454" height="121" alt="Screenshot From 2026-10-13 16-30-47" src="https://github.com/user-attachments/assets/62b4e7a7-b727-4e25-ade4-7e530fd110cb" /> r? @Urgau

…uwer Rollup of 11 pull requests Successful merges: - #162749 (Recover missing `turbofish` for `lifetime` arguments in expression position) - #164170 (Prefer WriteConsoleW for stdout on Windows) - #164255 (test DSL eagerly handle false constraints) - #163230 (Document zero-sized allocations properly for `Box` and `Vec`) - #163940 (Parse move exprs as a bottom expr instead of a prefix expr) - #164219 (Windows FileExt trait doesn't need to handle ErrorKind::Interrupted; test improvements for same) - #164220 (Test the interaction between `--remap-path-prefix` and doctests) - #164266 (rustdoc: Improvements for `rustc_must_implement_one_of`) - #164272 (Add regression test for #155977) - #164287 (Add regression test for hang in overlap check with GAT alias) - #164301 (fix issue number for feature(unsized_const_params))

@Urgau

…t_one_of, r=Urgau rustdoc: Improvements for `rustc_must_implement_one_of` Fixes rust-lang#163675. Funnily enough, most things are actually already there, so this PR is only an improvement over the following: * The methods listed in the note are now links. * The note itself got a little display improvement (unified with the existing ones mostly, screenshots below). * Added the `Required Methods` heading in the sidebar if `rustc_must_implement_one_of` is used Before: <img width="407" height="114" alt="Screenshot From 2026-10-13 16-30-39" src="https://github.com/user-attachments/assets/ccbe09bd-437a-45ab-a6ae-e77f02c68b19" /> After: <img width="454" height="121" alt="Screenshot From 2026-10-13 16-30-47" src="https://github.com/user-attachments/assets/62b4e7a7-b727-4e25-ade4-7e530fd110cb" /> r? @Urgau

@Urgau

…t_one_of, r=Urgau rustdoc: Improvements for `rustc_must_implement_one_of` Fixes rust-lang#163675. Funnily enough, most things are actually already there, so this PR is only an improvement over the following: * The methods listed in the note are now links. * The note itself got a little display improvement (unified with the existing ones mostly, screenshots below). * Added the `Required Methods` heading in the sidebar if `rustc_must_implement_one_of` is used Before: <img width="407" height="114" alt="Screenshot From 2026-10-13 16-30-39" src="https://github.com/user-attachments/assets/ccbe09bd-437a-45ab-a6ae-e77f02c68b19" /> After: <img width="454" height="121" alt="Screenshot From 2026-10-13 16-30-47" src="https://github.com/user-attachments/assets/62b4e7a7-b727-4e25-ade4-7e530fd110cb" /> r? @Urgau

…uwer Rollup of 17 pull requests Successful merges: - #162749 (Recover missing `turbofish` for `lifetime` arguments in expression position) - #164165 (Add a new `rustc_show_spans` internal attribute) - #164170 (Prefer WriteConsoleW for stdout on Windows) - #164208 (Implement better resolution for delegation `Self` mapping field) - #164255 (test DSL eagerly handle false constraints) - #163230 (Document zero-sized allocations properly for `Box` and `Vec`) - #163442 (Fix fudging) - #163940 (Parse move exprs as a bottom expr instead of a prefix expr) - #164079 (document some quirks around directory symlinks on Windows) - #164178 (Fix `diagnostic::on_unknown` format placeholder for paths in expressions and type paths) - #164219 (Windows FileExt trait doesn't need to handle ErrorKind::Interrupted; test improvements for same) - #164266 (rustdoc: Improvements for `rustc_must_implement_one_of`) - #164272 (Add regression test for #155977) - #164287 (Add regression test for hang in overlap check with GAT alias) - #164292 (Remove the `span_use_eq_ctxt` lint) - #164301 (fix issue number for feature(unsized_const_params)) - #164309 (point at the opaque when its hidden type cannot be inferred)

@Urgau

Rollup merge of #164266 - GuillaumeGomez:rustc_must_implement_one_of, r=Urgau rustdoc: Improvements for `rustc_must_implement_one_of` Fixes #163675. Funnily enough, most things are actually already there, so this PR is only an improvement over the following: * The methods listed in the note are now links. * The note itself got a little display improvement (unified with the existing ones mostly, screenshots below). * Added the `Required Methods` heading in the sidebar if `rustc_must_implement_one_of` is used Before: <img width="407" height="114" alt="Screenshot From 2026-10-13 16-30-39" src="https://github.com/user-attachments/assets/ccbe09bd-437a-45ab-a6ae-e77f02c68b19" /> After: <img width="454" height="121" alt="Screenshot From 2026-10-13 16-30-47" src="https://github.com/user-attachments/assets/62b4e7a7-b727-4e25-ade4-7e530fd110cb" /> r? @Urgau

…uwer Rollup of 17 pull requests Successful merges: - rust-lang/rust#162749 (Recover missing `turbofish` for `lifetime` arguments in expression position) - rust-lang/rust#164165 (Add a new `rustc_show_spans` internal attribute) - rust-lang/rust#164170 (Prefer WriteConsoleW for stdout on Windows) - rust-lang/rust#164208 (Implement better resolution for delegation `Self` mapping field) - rust-lang/rust#164255 (test DSL eagerly handle false constraints) - rust-lang/rust#163230 (Document zero-sized allocations properly for `Box` and `Vec`) - rust-lang/rust#163442 (Fix fudging) - rust-lang/rust#163940 (Parse move exprs as a bottom expr instead of a prefix expr) - rust-lang/rust#164079 (document some quirks around directory symlinks on Windows) - rust-lang/rust#164178 (Fix `diagnostic::on_unknown` format placeholder for paths in expressions and type paths) - rust-lang/rust#164219 (Windows FileExt trait doesn't need to handle ErrorKind::Interrupted; test improvements for same) - rust-lang/rust#164266 (rustdoc: Improvements for `rustc_must_implement_one_of`) - rust-lang/rust#164272 (Add regression test for rust-lang/rust#155977) - rust-lang/rust#164287 (Add regression test for hang in overlap check with GAT alias) - rust-lang/rust#164292 (Remove the `span_use_eq_ctxt` lint) - rust-lang/rust#164301 (fix issue number for feature(unsized_const_params)) - rust-lang/rust#164309 (point at the opaque when its hidden type cannot be inferred)

@Urgau

…r=lolbinarycat [rustdoc] Add the Dyn Compatibility heading all the time in the sidebar since it is always in the doc The 3 first commits come from rust-lang#164266. While working on it, I realized that even though we added a condition for the sidebar heading, we always have: <img width="520" height="146" alt="image" src="https://github.com/user-attachments/assets/94a7c109-6cc0-4a37-831b-7e40a06f44a4" /> So there should be a heading to reflect it. r? @Urgau

@Urgau

…r=lolbinarycat [rustdoc] Add the Dyn Compatibility heading all the time in the sidebar since it is always in the doc The 3 first commits come from rust-lang#164266. While working on it, I realized that even though we added a condition for the sidebar heading, we always have: <img width="520" height="146" alt="image" src="https://github.com/user-attachments/assets/94a7c109-6cc0-4a37-831b-7e40a06f44a4" /> So there should be a heading to reflect it. r? @Urgau

@Urgau

Rollup merge of #164268 - GuillaumeGomez:dyn-compatibility, r=lolbinarycat [rustdoc] Add the Dyn Compatibility heading all the time in the sidebar since it is always in the doc The 3 first commits come from #164266. While working on it, I realized that even though we added a condition for the sidebar heading, we always have: <img width="520" height="146" alt="image" src="https://github.com/user-attachments/assets/94a7c109-6cc0-4a37-831b-7e40a06f44a4" /> So there should be a heading to reflect it. r? @Urgau

GuillaumeGomez added 2 commits October 13, 2026 16:27

[rustdoc] Improve display of rustc_must_implement_one_of note and g…

eb85bf4

…enerate links to the mentioned methods

[rustdoc] Generate sidebar link for "required methods" even if there …

fe97485

…are none if the `rustc_must_implement_one_of` attribute is present

rustbot assigned Urgau Oct 13, 2026

This was referenced Oct 13, 2026

[rustdoc] Add the Dyn Compatibility heading all the time in the sidebar since it is always in the doc #164268

Merged

std::io::Read incorrectly has no marked required methods #163675

Closed

Urgau reviewed Oct 13, 2026

View reviewed changes

Comment thread tests/rustdoc-html/trait-rustc_must_implement_one_of.rs

Add regression test for rustc_must_implement_one_of changes

cad2ab9

GuillaumeGomez force-pushed the rustc_must_implement_one_of branch from 08a8c4f to cad2ab9 Compare October 13, 2026 19:37

Urgau approved these changes Oct 13, 2026

View reviewed changes

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 Oct 13, 2026

jhpratt mentioned this pull request Oct 14, 2026

Rollup of 9 pull requests #164296

Closed

JonathanBrouwer mentioned this pull request Oct 14, 2026

Rollup of 11 pull requests #164305

Closed

This was referenced Oct 14, 2026

Rollup of 13 pull requests #164316

Closed

Rollup of 17 pull requests #164322

Merged

rust-bors Bot merged commit 7c9e02f into rust-lang:main Oct 14, 2026
14 checks passed

rustbot added this to the 1.101.0 milestone Oct 14, 2026

GuillaumeGomez deleted the rustc_must_implement_one_of branch October 14, 2026 22:01

github-actions Bot mentioned this pull request Oct 22, 2026

Toolchain upgrade to nightly-2026-10-22 flux-rs/flux#1847

Merged

Navigation Menu

Repository navigation

rustdoc: Improvements for `rustc_must_implement_one_of` - #164266

rustdoc: Improvements for `rustc_must_implement_one_of`#164266
rust-bors[bot] merged 3 commits into
rust-lang:mainfrom
GuillaumeGomez:rustc_must_implement_one_of

GuillaumeGomez commented Oct 13, 2026

Uh oh!

Uh oh!

Urgau left a comment •

edited by rustbot

Loading

Uh oh!

Urgau commented Oct 13, 2026

Uh oh!

rust-bors Bot commented Oct 13, 2026

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

GuillaumeGomez commented Oct 13, 2026

Uh oh!

Uh oh!

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

Urgau commented Oct 13, 2026

Uh oh!

rust-bors Bot commented Oct 13, 2026

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Urgau left a comment •

edited by rustbot

Loading