Return &T / &mut T in ManuallyDrop Deref(Mut) impl #55485
Conversation
Without this change the generated documentation looks like this:
fn deref(&self) -> &<ManuallyDrop<T> as Deref>::Target
Returning the actual type directly makes the generated docs more clear:
fn deref(&self) -> &T
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @aidanhs (or someone else) soon. If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes. Please see the contribution instructions for more information. |
rust-highfive
added
the
S-waiting-on-review
|
We should land this PR, but... ...To me this feels like a bug in rustdoc that you see |
|
Humorously enough, the impl looks just fine in core's version of the Deref docs, so it's a problem with how the information comes out in the re-export.
I can try looking into this over the next few days, but "information gets weird when something is re-exported" is a common problem in rustdoc, sadly. |
|
Ping from triage @QuietMisdreavus / @Centril / @aidanhs: Do you think it is worth it to merge this PR as is, while the rustdoc issue is figured out? |
|
Yes. |
|
Yes, i think this makes the docs better and allows us to take more time to investigate the underlying issue (which haven't taken the opportunity to investigate |
|
@bors r+ rollup |
|
📌 Commit bc18857 has been approved by |
bors
added
S-waiting-on-bors
…f, r=TimNN
Return &T / &mut T in ManuallyDrop Deref(Mut) impl
Without this change the generated documentation looks like this:
fn deref(&self) -> &<ManuallyDrop<T> as Deref>::Target
Returning the actual type directly makes the generated docs more clear:
fn deref(&self) -> &T
Basically, compare how the impl for `Box<T>` and `ManuallyDrop<T>` looks in this screenshot:
Rollup of 11 pull requests Successful merges: - #55367 (lint if a private item has doctests) - #55485 (Return &T / &mut T in ManuallyDrop Deref(Mut) impl) - #55784 (Clarifying documentation for collections::hash_map::Entry::or_insert) - #55961 (Fix VecDeque pretty-printer) - #55980 (Suggest on closure args count mismatching with pipe span) - #56002 (fix #55972: Erroneous self arguments on bare functions emit subpar compilation error) - #56063 (Update any.rs documentation using keyword dyn) - #56067 (Add SGX target to rustc) - #56078 (Fix error message for `-C panic=xxx`.) - #56106 (Remove some incorrect doc comments) - #56126 (core/benches/num: Add `from_str/from_str_radix()` benchmarks) Failed merges: r? @ghost
Without this change the generated documentation looks like this:
Returning the actual type directly makes the generated docs more clear:
Basically, compare how the impl for
Box<T>andManuallyDrop<T>looks in this screenshot: