rustdoc: make primitive synthetic impls for correct doc module #96301

notriddle · 2022-04-22T00:07:06Z

This improves the accuracy of libcore primitive docs, which was missing the blanket and auto impls for most primitive types. To test this, compare nightly libcore::str docs, which lack auto traits like Send, with libstd::str docs, which show them.

It also avoids getting synthetic impls for primitive types on crates that do not actually show them.

Before and After trace logs

Before

[notriddle@deep-thought test-dingus]$ RUSTDOC_LOG=rustdoc=trace rustdoc +nightly test.rs 2>&1 | grep -E 'get_blanket_impls\('
TRACE rustdoc::clean::blanket_impl get_blanket_impls(Whatever)
TRACE rustdoc::clean::blanket_impl get_blanket_impls(isize)
TRACE rustdoc::clean::blanket_impl get_blanket_impls([T])
TRACE rustdoc::clean::blanket_impl get_blanket_impls([u8])
TRACE rustdoc::clean::blanket_impl get_blanket_impls([T])
TRACE rustdoc::clean::blanket_impl get_blanket_impls([u8])
TRACE rustdoc::clean::blanket_impl get_blanket_impls(char)
TRACE rustdoc::clean::blanket_impl get_blanket_impls(u128)
TRACE rustdoc::clean::blanket_impl get_blanket_impls(u16)
TRACE rustdoc::clean::blanket_impl get_blanket_impls(i128)
TRACE rustdoc::clean::blanket_impl get_blanket_impls(i16)
TRACE rustdoc::clean::blanket_impl get_blanket_impls(str)
TRACE rustdoc::clean::blanket_impl get_blanket_impls(str)
TRACE rustdoc::clean::blanket_impl get_blanket_impls(f64)
TRACE rustdoc::clean::blanket_impl get_blanket_impls(f64)
TRACE rustdoc::clean::blanket_impl get_blanket_impls(u64)
TRACE rustdoc::clean::blanket_impl get_blanket_impls(u8)
TRACE rustdoc::clean::blanket_impl get_blanket_impls(i64)
TRACE rustdoc::clean::blanket_impl get_blanket_impls(i8)
TRACE rustdoc::clean::blanket_impl get_blanket_impls(*const T)
TRACE rustdoc::clean::blanket_impl get_blanket_impls(*mut T)
TRACE rustdoc::clean::blanket_impl get_blanket_impls(*const [T])
TRACE rustdoc::clean::blanket_impl get_blanket_impls(*mut [T])
TRACE rustdoc::clean::blanket_impl get_blanket_impls([T; N])
TRACE rustdoc::clean::blanket_impl get_blanket_impls(bool)
TRACE rustdoc::clean::blanket_impl get_blanket_impls(f32)
TRACE rustdoc::clean::blanket_impl get_blanket_impls(f32)
TRACE rustdoc::clean::blanket_impl get_blanket_impls(u32)
TRACE rustdoc::clean::blanket_impl get_blanket_impls(usize)
TRACE rustdoc::clean::blanket_impl get_blanket_impls(i32)

After

[notriddle@deep-thought test-dingus]$ RUSTDOC_LOG=rustdoc=trace rustdoc +dev test.rs 2>&1 | grep -E 'get_blanket_impls\('
TRACE rustdoc::clean::blanket_impl get_blanket_impls(Whatever)

This improves the accuracy of libcore primitive docs, which was missing the blanket and auto impls for most primitive types. To test this, compare nightly [libcore::str] docs, which lack auto traits like Send, with [std::str] docs, which show them. [libcore::str]: https://doc.rust-lang.org/nightly/core/primitive.str.html [libstd::str]: https://doc.rust-lang.org/nightly/std/primitive.str.html It also avoids getting synthetic impls for primitive types on crates that do not actually show them. <details> <summary>Before and After trace logs</summary> Before: [notriddle@deep-thought test-dingus]$ RUSTDOC_LOG=rustdoc=trace rustdoc +nightly test.rs 2>&1 | grep -E 'get_blanket_impls\(' TRACE rustdoc::clean::blanket_impl get_blanket_impls(Whatever) TRACE rustdoc::clean::blanket_impl get_blanket_impls(isize) TRACE rustdoc::clean::blanket_impl get_blanket_impls([T]) TRACE rustdoc::clean::blanket_impl get_blanket_impls([u8]) TRACE rustdoc::clean::blanket_impl get_blanket_impls([T]) TRACE rustdoc::clean::blanket_impl get_blanket_impls([u8]) TRACE rustdoc::clean::blanket_impl get_blanket_impls(char) TRACE rustdoc::clean::blanket_impl get_blanket_impls(u128) TRACE rustdoc::clean::blanket_impl get_blanket_impls(u16) TRACE rustdoc::clean::blanket_impl get_blanket_impls(i128) TRACE rustdoc::clean::blanket_impl get_blanket_impls(i16) TRACE rustdoc::clean::blanket_impl get_blanket_impls(str) TRACE rustdoc::clean::blanket_impl get_blanket_impls(str) TRACE rustdoc::clean::blanket_impl get_blanket_impls(f64) TRACE rustdoc::clean::blanket_impl get_blanket_impls(f64) TRACE rustdoc::clean::blanket_impl get_blanket_impls(u64) TRACE rustdoc::clean::blanket_impl get_blanket_impls(u8) TRACE rustdoc::clean::blanket_impl get_blanket_impls(i64) TRACE rustdoc::clean::blanket_impl get_blanket_impls(i8) TRACE rustdoc::clean::blanket_impl get_blanket_impls(*const T) TRACE rustdoc::clean::blanket_impl get_blanket_impls(*mut T) TRACE rustdoc::clean::blanket_impl get_blanket_impls(*const [T]) TRACE rustdoc::clean::blanket_impl get_blanket_impls(*mut [T]) TRACE rustdoc::clean::blanket_impl get_blanket_impls([T; N]) TRACE rustdoc::clean::blanket_impl get_blanket_impls(bool) TRACE rustdoc::clean::blanket_impl get_blanket_impls(f32) TRACE rustdoc::clean::blanket_impl get_blanket_impls(f32) TRACE rustdoc::clean::blanket_impl get_blanket_impls(u32) TRACE rustdoc::clean::blanket_impl get_blanket_impls(usize) TRACE rustdoc::clean::blanket_impl get_blanket_impls(i32) After: [notriddle@deep-thought test-dingus]$ RUSTDOC_LOG=rustdoc=trace rustdoc +dev test.rs 2>&1 | grep -E 'get_blanket_impls\(' TRACE rustdoc::clean::blanket_impl get_blanket_impls(Whatever) </details>

rust-highfive · 2022-04-22T00:07:09Z

r? @CraftSpider

(rust-highfive has picked a reviewer for you, use r? to override)

GuillaumeGomez · 2022-04-22T12:18:00Z

Tested locally and looks good to me. Let's run a perf check since I suppose it'll impact perf.

@bors try @rust-timer queue

rust-timer · 2022-04-22T12:18:01Z

Awaiting bors try build completion.

@rustbot label: +S-waiting-on-perf

bors · 2022-04-22T12:18:08Z

⌛ Trying commit 2e7b5ab with merge f78bea524380c39d97593ebadfdc905fdd5948e8...

bors · 2022-04-22T13:43:12Z

☀️ Try build successful - checks-actions
Build commit: f78bea524380c39d97593ebadfdc905fdd5948e8 (f78bea524380c39d97593ebadfdc905fdd5948e8)

rust-timer · 2022-04-22T13:43:14Z

Queued f78bea524380c39d97593ebadfdc905fdd5948e8 with parent 8d68f2f, future comparison URL.

rust-timer · 2022-04-22T14:58:20Z

Finished benchmarking commit (f78bea524380c39d97593ebadfdc905fdd5948e8): comparison url.

Summary:

Primary benchmarks: 🎉 relevant improvements found
Secondary benchmarks: 🎉 relevant improvements found

	Regressions 😿 (primary)	Regressions 😿 (secondary)	Improvements 🎉 (primary)	Improvements 🎉 (secondary)	All 😿 🎉 (primary)
count¹	0	0	16	21	16
mean²	N/A	N/A	-1.2%	-2.1%	-1.2%
max	N/A	N/A	-3.0%	-3.3%	-3.0%

If you disagree with this performance assessment, please file an issue in rust-lang/rustc-perf.

Benchmarking this pull request likely means that it is perf-sensitive, so we're automatically marking it as not fit for rolling up. While you can manually mark this PR as fit for rollup, we strongly recommend not doing so since this PR may lead to changes in compiler perf.

@bors rollup=never
@rustbot label: +S-waiting-on-review -S-waiting-on-perf -perf-regression

number of relevant changes ↩
the arithmetic mean of the percent change ↩

GuillaumeGomez · 2022-04-22T15:07:18Z

Perfect. Let's go then!

@bors r+ rollup=never

bors · 2022-04-22T15:07:19Z

📌 Commit 2e7b5ab has been approved by GuillaumeGomez

bors · 2022-04-22T16:47:16Z

⌛ Testing commit 2e7b5ab with merge 5ffebc2...

bors · 2022-04-22T19:27:56Z

☀️ Test successful - checks-actions
Approved by: GuillaumeGomez
Pushing 5ffebc2 to master...

rust-timer · 2022-04-22T20:43:37Z

Finished benchmarking commit (5ffebc2): comparison url.

Summary:

Primary benchmarks: 🎉 relevant improvements found
Secondary benchmarks: 🎉 relevant improvements found

	Regressions 😿 (primary)	Regressions 😿 (secondary)	Improvements 🎉 (primary)	Improvements 🎉 (secondary)	All 😿 🎉 (primary)
count¹	0	0	16	21	16
mean²	N/A	N/A	-1.2%	-2.1%	-1.2%
max	N/A	N/A	-3.0%	-3.3%	-3.0%

If you disagree with this performance assessment, please file an issue in rust-lang/rustc-perf.

@rustbot label: -perf-regression

number of relevant changes ↩
the arithmetic mean of the percent change ↩

rustbot added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Apr 22, 2022

rust-highfive assigned CraftSpider Apr 22, 2022

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Apr 22, 2022

notriddle requested a review from GuillaumeGomez April 22, 2022 06:57

rustbot added the S-waiting-on-perf Status: Waiting on a perf run to be completed. label Apr 22, 2022

rustbot removed the S-waiting-on-perf Status: Waiting on a perf run to be completed. label Apr 22, 2022

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 Apr 22, 2022

bors added the merged-by-bors This PR was explicitly merged by bors. label Apr 22, 2022

bors merged commit 5ffebc2 into rust-lang:master Apr 22, 2022

rustbot added this to the 1.62.0 milestone Apr 22, 2022

notriddle deleted the notriddle/synthetic-impl-prim branch April 22, 2022 19:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

rustdoc: make primitive synthetic impls for correct doc module #96301

rustdoc: make primitive synthetic impls for correct doc module #96301

notriddle commented Apr 22, 2022 •

edited

Loading

rust-highfive commented Apr 22, 2022

GuillaumeGomez commented Apr 22, 2022

rust-timer commented Apr 22, 2022

bors commented Apr 22, 2022

bors commented Apr 22, 2022

rust-timer commented Apr 22, 2022

rust-timer commented Apr 22, 2022

GuillaumeGomez commented Apr 22, 2022

bors commented Apr 22, 2022

bors commented Apr 22, 2022

bors commented Apr 22, 2022

rust-timer commented Apr 22, 2022

rustdoc: make primitive synthetic impls for correct doc module #96301

rustdoc: make primitive synthetic impls for correct doc module #96301

Conversation

notriddle commented Apr 22, 2022 • edited Loading

Before

After

rust-highfive commented Apr 22, 2022

GuillaumeGomez commented Apr 22, 2022

rust-timer commented Apr 22, 2022

bors commented Apr 22, 2022

bors commented Apr 22, 2022

rust-timer commented Apr 22, 2022

rust-timer commented Apr 22, 2022

Footnotes

GuillaumeGomez commented Apr 22, 2022

bors commented Apr 22, 2022

bors commented Apr 22, 2022

bors commented Apr 22, 2022

rust-timer commented Apr 22, 2022

Footnotes

notriddle commented Apr 22, 2022 •

edited

Loading