This Week in Rust Docs 102

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

We added settings into generated documentation so you can have your own setup. We’ll add more options soon to make rust documentation browsing more personal and comfortable for everyone!

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

@QuietMisdreavus moved the “important traits” button to beside the type in rustdoc.
@klnusbaum provided better borrow checker error message.
@PramodBisht fixed doc comments present after a particular syntax error cause an unhelpful error message to be output.
@zackmdavis pointed to value in “value assigned is never read” lint.
@sgrif removed the “leak check” in favor of “universes”.
@ecstatic-morse rewrote docs for std::ptr and added doc links to std::os extension traits.
@steveklabnik added “the Rustc book”.
@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.
@mattico updated mdbook.
@andjo403 made rustdoc tests follow the jobserver limit of threads.
@GuillaumeGomez added repeat method on slice, stabilized short error format, added rustdoc settings menu and fixed search bar bug.

Recent doc contributions

@QuietMisdreavus ported the -C option from rustc into rustdoc.
@csmoe fixed incorrect span in &mut suggestion.
@krk clarified E0015 message.
@varkor added rustdoc to x.py check.
@Zoxc improved query cycle error message.
@ollie27 removed private paths in all.html in rustdoc.
@GuillaumeGomez added warning if a resolution failed, added specific never search and added multiple query search.

Meetings

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

Written on April 22, 2018