Join GitHub today
Return &T / &mut T in ManuallyDrop Deref(Mut) impl #55485
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
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.
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.