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:

• Stable
• Beta
• Nightly

This week’s edition was edited by Guillaume Gomez.

Latest news

The rewrite of rustdoc is still under heavy development. Don’t hesitate to give it a try!

Current opened issues

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

• The Standard Library Documentation Checklist
• Add error explanations for all error codes
• Document all features in the Rust reference

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

• @qnighy added hints when intercrate ambiguity causes overlap.
• @huntiep improved Try error messages.
• @QuietMisdreavus added new “Implementations on Foreign Types” section to traits in rustdoc and hid internal types/traits from std docs via new #[doc(masked)] attribute.
• @zackmdavis added comparison operators to must-use lint (under fn_must_use feature).
• @ishitatsuyuki made unused-extern-crate warn-by-default.
• @llogiq added a lowercase suggestion to unknown_lints.
• @gaurikholkar extended E0623 for LateBound and EarlyBound Regions.
• @oli-obk added clippy as a submodule and suggested Ok(()) when encountering Result::<(), E>::Ok().
• @mystor removed highlight of # which does not start an attribute in rustdoc.
• @GuillaumeGomez added warnings when rustdoc html rendering differs, compile fail stable and added deref suggestion.

Recent doc contributions

• @oli-obk improved placement of use suggestions.
• @ruuda pointed “deref coercions” links to new book.
• @gaurikholkar added E0623 for structs.
• @shanavas786 fixed typo in doc.
• @estebank pointed out missing if conditional.
• @lukaramu fixed inconsistent doc headings.
• @Jouan added links for impls.
• @mattico clarified windows build instructions in README.
• @remexre mentionned null_mut on the pointer primitive docs.
• @GuillaumeGomez added missing links in docs, removed outline when details have focus, removed duplicates in rustdoc, add missing link in string doc, add missing links for Read trait and rollup of 5 pull requests.

Meetings

Next meeting will be on Wednesday 30th of August 2017 at 20:00 GMT on #rust-docs channel on irc.mozilla.org. Feel free to come!