Improve the function pointer docs #98180

notriddle · 2022-06-16T21:45:06Z

This is #97842 but for function pointers instead of tuples. The concept is basically the same.

Reduce duplicate impls; show fn (T₁, T₂, …, Tₙ) and include a sentence saying that there exists up to twelve of them.
Show Copy and Clone.
Show auto traits like Send and Sync, and blanket impls like Any.

https://notriddle.com/notriddle-rustdoc-test/std/primitive.fn.html

rust-highfive · 2022-06-16T21:45:09Z

Some changes occurred in clean/types.rs.

Hey! It looks like you've submitted a new PR for the library teams!

If this PR contains changes to any rust-lang/rust public library APIs then please comment with @rustbot label +T-libs-api -T-libs to tag it appropriately. If this PR contains changes to any unstable APIs please edit the PR description to add a link to the relevant API Change Proposal or create one if you haven't already. If you're unsure where your change falls no worries, just leave it as is and the reviewer will take a look and make a decision to forward on if necessary.

Examples of T-libs-api changes:

Stabilizing library features
Introducing insta-stable changes such as new implementations of existing stable traits on existing stable types
Introducing new or changing existing unstable library APIs (excluding permanently unstable features / features without a tracking issue)
Changing public documentation in ways that create new stability guarantees
Changing observable runtime behavior of library APIs

rust-highfive · 2022-06-16T21:45:10Z

r? @joshtriplett

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

rustbot · 2022-07-04T04:14:14Z

Some changes occurred in src/librustdoc/clean/types.rs

cc @camelid

Hey! It looks like you've submitted a new PR for the library teams!

If this PR contains changes to any rust-lang/rust public library APIs then please comment with @rustbot label +T-libs-api -T-libs to tag it appropriately. If this PR contains changes to any unstable APIs please edit the PR description to add a link to the relevant API Change Proposal or create one if you haven't already. If you're unsure where your change falls no worries, just leave it as is and the reviewer will take a look and make a decision to forward on if necessary.

Examples of T-libs-api changes:

Stabilizing library features
Introducing insta-stable changes such as new implementations of existing stable traits on existing stable types
Introducing new or changing existing unstable library APIs (excluding permanently unstable features / features without a tracking issue)
Changing public documentation in ways that create new stability guarantees
Changing observable runtime behavior of library APIs

The attribute is also renamed `fake_variadic`.

GuillaumeGomez · 2022-07-18T09:16:53Z

Just looked at your hosted docs and saw this:

Not sure if it comes from this PR or not though. If not, I'll resume the review and open an issue. :)

notriddle · 2022-07-18T10:27:09Z

That’s unfortunate, and I’m not sure what the right solution is, but it’s needed to signal that the impl:

is an impl for C-style variadic functions
supports an arbitrary number of non-variadic arguments

Both, at the same time.

GuillaumeGomez · 2022-07-18T11:01:06Z

It's so weird. I don't think we can do better or at least I don't see how. Would be nice if we could also improve the sidebar items because having the same one multiple times isn't great (but not part of this PR).

library/core/src/primitive_docs.rs

library/core/src/ptr/mod.rs

library/std/src/primitive_docs.rs

src/librustdoc/html/format.rs

GuillaumeGomez · 2022-07-18T15:33:52Z

Looks good to me, thanks! I'd just like to have someone from the compiler to confirm the changes on their side before approving it though. I'll let you ping someone from their team.

notriddle · 2022-07-18T15:56:43Z

r? rust-lang/compiler

src/librustdoc/html/format.rs

petrochenkov · 2022-07-19T15:42:14Z

r=me after squashing commits.
@rustbot author

* Reduce duplicate impls; show only the `fn (T)` and include a sentence saying that there exists up to twelve of them. * Show `Copy` and `Clone`. * Show auto traits like `Send` and `Sync`, and blanket impls like `Any`.

notriddle · 2022-07-19T17:29:21Z

@bors r=petrochenkov,GuillaumeGomez rollup=never

bors · 2022-07-19T17:29:23Z

📌 Commit ddb5a26 has been approved by petrochenkov,GuillaumeGomez

It is now in the queue for this repository.

bors · 2022-07-19T19:37:01Z

⌛ Testing commit ddb5a26 with merge 9a7b7d5...

bors · 2022-07-19T23:07:36Z

☀️ Test successful - checks-actions
Approved by: petrochenkov,GuillaumeGomez
Pushing 9a7b7d5 to master...

rust-timer · 2022-07-20T01:01:41Z

Finished benchmarking commit (9a7b7d5): comparison url.

Instruction count

Primary benchmarks: 😿 relevant regressions found
Secondary benchmarks: mixed results

	mean¹	max	count²
Regressions 😿 (primary)	0.2%	0.3%	3
Regressions 😿 (secondary)	0.4%	0.4%	8
Improvements 🎉 (primary)	N/A	N/A	0
Improvements 🎉 (secondary)	-1.2%	-1.2%	1
All 😿🎉 (primary)	0.2%	0.3%	3

Max RSS (memory usage)

Results

Primary benchmarks: 🎉 relevant improvement found
Secondary benchmarks: mixed results

	mean¹	max	count²
Regressions 😿 (primary)	N/A	N/A	0
Regressions 😿 (secondary)	1.4%	1.4%	1
Improvements 🎉 (primary)	-3.2%	-3.2%	1
Improvements 🎉 (secondary)	-2.2%	-2.3%	2
All 😿🎉 (primary)	-3.2%	-3.2%	1

Cycles

Results

Primary benchmarks: 😿 relevant regressions found
Secondary benchmarks: no relevant changes found

	mean¹	max	count²
Regressions 😿 (primary)	2.5%	2.8%	2
Regressions 😿 (secondary)	N/A	N/A	0
Improvements 🎉 (primary)	N/A	N/A	0
Improvements 🎉 (secondary)	N/A	N/A	0
All 😿🎉 (primary)	2.5%	2.8%	2

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

Next Steps: If you can justify the regressions found in this perf run, please indicate this with @rustbot label: +perf-regression-triaged along with sufficient written justification. If you cannot justify the regressions please open an issue or create a new PR that fixes the regressions, add a comment linking to the newly created issue or PR, and then add the perf-regression-triaged label to this PR.

@rustbot label: +perf-regression

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

pnkfelix · 2022-07-27T19:16:36Z

The regressions above are all in doc generation, and they are all minor.

@rustbot label: +perf-regression-triaged

…ke-variadic, r=notriddle rustdoc: Remove space from fake-variadic fn ptr impls before: `for fn (T₁, T₂, …, Tₙ) -> Ret` after: `for fn(T₁, T₂, …, Tₙ) -> Ret` I don't think we usually have spaces there, so it looks weird. cc `@notriddle` since you added the space in rust-lang#98180 (or rather, added the feature with a space included).

…-variadic, r=notriddle rustdoc: Remove space from fake-variadic fn ptr impls before: `for fn (T₁, T₂, …, Tₙ) -> Ret` after: `for fn(T₁, T₂, …, Tₙ) -> Ret` I don't think we usually have spaces there, so it looks weird. cc `@notriddle` since you added the space in rust-lang#98180 (or rather, added the feature with a space included).

…, r=notriddle rustdoc: Remove space from fake-variadic fn ptr impls before: `for fn (T₁, T₂, …, Tₙ) -> Ret` after: `for fn(T₁, T₂, …, Tₙ) -> Ret` I don't think we usually have spaces there, so it looks weird. cc `@notriddle` since you added the space in rust-lang/rust#98180 (or rather, added the feature with a space included).

rust-highfive assigned joshtriplett Jun 16, 2022

rustbot added T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. T-libs Relevant to the library team, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Jun 16, 2022

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

This comment has been minimized.

Sign in to view

notriddle force-pushed the notriddle/rustdoc-fn branch 2 times, most recently from 1244cdb to 75568c8 Compare June 17, 2022 00:47

nnethercote mentioned this pull request Jun 24, 2022

Don't use match-destructuring for derived ops on structs. #98446

Merged

This comment was marked as resolved.

Sign in to view

notriddle force-pushed the notriddle/rustdoc-fn branch from 75568c8 to 97dd790 Compare July 4, 2022 04:14

This comment was marked as resolved.

Sign in to view

rustdoc: extend #[doc(tuple_variadic)] to fn pointers

1169832

The attribute is also renamed `fake_variadic`.

notriddle force-pushed the notriddle/rustdoc-fn branch from 97dd790 to 1713e0e Compare July 17, 2022 23:41

notriddle assigned GuillaumeGomez Jul 17, 2022

GuillaumeGomez reviewed Jul 18, 2022

View reviewed changes

library/core/src/primitive_docs.rs Outdated Show resolved Hide resolved

GuillaumeGomez reviewed Jul 18, 2022

View reviewed changes

library/core/src/ptr/mod.rs Show resolved Hide resolved

GuillaumeGomez reviewed Jul 18, 2022

View reviewed changes

library/std/src/primitive_docs.rs Outdated Show resolved Hide resolved

GuillaumeGomez reviewed Jul 18, 2022

View reviewed changes

src/librustdoc/html/format.rs Outdated Show resolved Hide resolved

GuillaumeGomez approved these changes Jul 18, 2022

View reviewed changes

rust-highfive assigned petrochenkov Jul 18, 2022

rust-highfive unassigned GuillaumeGomez Jul 18, 2022

petrochenkov reviewed Jul 19, 2022

View reviewed changes

src/librustdoc/html/format.rs Outdated Show resolved Hide resolved

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 Jul 19, 2022

notriddle force-pushed the notriddle/rustdoc-fn branch from a60af82 to da9869f Compare July 19, 2022 15:51

notriddle added 2 commits July 19, 2022 08:52

Improve the function pointer docs

5271e32

* Reduce duplicate impls; show only the `fn (T)` and include a sentence saying that there exists up to twelve of them. * Show `Copy` and `Clone`. * Show auto traits like `Send` and `Sync`, and blanket impls like `Any`.

Use T for all the function primitive docs lists

ddb5a26

notriddle force-pushed the notriddle/rustdoc-fn branch from da9869f to ddb5a26 Compare July 19, 2022 15:52

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-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Jul 19, 2022

bors added the merged-by-bors This PR was explicitly merged by bors. label Jul 19, 2022

bors merged commit 9a7b7d5 into rust-lang:master Jul 19, 2022

rustbot added this to the 1.64.0 milestone Jul 19, 2022

bors mentioned this pull request Jul 19, 2022

Implement Debug, Pointer, etc on function pointers for all calling conventions #92964

Closed

notriddle deleted the notriddle/rustdoc-fn branch July 20, 2022 00:13

rustbot added the perf-regression Performance regression. label Jul 20, 2022

rustbot added the perf-regression-triaged The performance regression has been triaged. label Jul 27, 2022

CAD97 mentioned this pull request Jul 29, 2022

builtin trait to abstract over function pointers #99531

Closed

WaffleLapkin mentioned this pull request Nov 26, 2023

rustdoc: Remove space from fake-variadic fn ptr impls #118321

Merged

oli-obk mentioned this pull request Feb 4, 2024

Stop bailing out from compilation just because there were incoherent traits #120558

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve the function pointer docs #98180

Improve the function pointer docs #98180

notriddle commented Jun 16, 2022 •

edited

Loading

rust-highfive commented Jun 16, 2022

rust-highfive commented Jun 16, 2022

This comment has been minimized.

This comment has been minimized.

This comment was marked as resolved.

rustbot commented Jul 4, 2022

This comment was marked as resolved.

GuillaumeGomez commented Jul 18, 2022

notriddle commented Jul 18, 2022

GuillaumeGomez commented Jul 18, 2022

GuillaumeGomez commented Jul 18, 2022

notriddle commented Jul 18, 2022

petrochenkov commented Jul 19, 2022

notriddle commented Jul 19, 2022

bors commented Jul 19, 2022

bors commented Jul 19, 2022

bors commented Jul 19, 2022

rust-timer commented Jul 20, 2022

pnkfelix commented Jul 27, 2022

Improve the function pointer docs #98180

Improve the function pointer docs #98180

Conversation

notriddle commented Jun 16, 2022 • edited Loading

rust-highfive commented Jun 16, 2022

rust-highfive commented Jun 16, 2022

This comment has been minimized.

This comment has been minimized.

This comment was marked as resolved.

rustbot commented Jul 4, 2022

This comment was marked as resolved.

GuillaumeGomez commented Jul 18, 2022

notriddle commented Jul 18, 2022

GuillaumeGomez commented Jul 18, 2022

GuillaumeGomez commented Jul 18, 2022

notriddle commented Jul 18, 2022

petrochenkov commented Jul 19, 2022

notriddle commented Jul 19, 2022

bors commented Jul 19, 2022

bors commented Jul 19, 2022

bors commented Jul 19, 2022

rust-timer commented Jul 20, 2022

Instruction count

Max RSS (memory usage)

Cycles

Footnotes

pnkfelix commented Jul 27, 2022

notriddle commented Jun 16, 2022 •

edited

Loading