This Week in Rust Docs 104

Hello and welcome to This Week in Rust Docs!

This Week in Rust Docs is openly developed on GitHub. If you find any errors in this week’s issue, please submit a PR.

And of course, don’t forget to look at the docs:

This week’s edition was edited by Guillaume Gomez.

Latest news

Some improvements on JS size are being worked on. More to come soon!

Current opened issues

For now, here are the three big issues for Rust documentation:

They all need help to move forward so any contribution is very welcome!

There are currently around 70 other documentation issues opened. Look for T-doc tagged issues on GitHub!

Waiting for merge

@sgrif removed the “leak check” in favor of “universes”.
@ecstatic-morse rewrote docs for std::ptr.
@da-x included scope names in diagnostics.
@Phlosioneer clarified the difference between get_mut and into_mut for OccupiedEntry.
@ibabushkin refactored auto trait handling in librustdoc to be accessible from librustc.
@rizakrko added missing implementation hint.
@mulkieran made some documentation fixes for the Write trait.
@clarcharr added missing Wrapping methods and mentionned Result<!, E> in never docs.
@nikomatsakis improved single-use and zero-use lifetime lints.
@zackmdavis removed crazy suggestion for unreachable braced pub-use.
@fkjogu documented round-off error in .mod_euc()-method.
@GuillaumeGomez stabilized short error format, prevented infinite recursion of modules in rustdoc, made some rustdoc improvements and fixed rustdoc pathes search.

Recent doc contributions

@Manishearth used enum for approximate suggestions.
@z4v1er fixed typo.
@kornelski buried Error::description() and suggested more helpful formatting string.
@kennytm clarified wordings of the unstable_name_collision lint.
@frewsxcv updated books for the next release.
@sinkuu resolved nested impl Traits in rustdoc.
@varkor displayed correct unused field suggestion for nested struct patterns and improved error message for #[repr(align=x)].
@ehuss fixed some broken links in docs.
@Pazzaz added more links in panic docs.
@ollie27 fixed links to constants in external crates in rustdoc.
@GuillaumeGomez added query search order check, fixed invalid path generation in rustdoc search and renamed “show type declaration” to “show declaration”.

Meetings

Next meeting will be on Tuesday 8th of May 2018 at 19:00 UTC on #rust-docs channel on irc.mozilla.org. Feel free to come!

Written on May 6, 2018