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 switch to Pulldown for the rust doc rendering has finally started!

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.
• @QuietMisdreavus added new “Implementations on Foreign Types” section to traits in rustdoc, hid internal types/traits from std docs via new #[doc(masked)] attribute and expanded on using rustup custom toolchains in CONTRIBUTING.md.
• @gaurikholkar extended E0623 for LateBound and EarlyBound Regions and added E0623 for return types - both parameters are anonymous.
• @Mark-Simulacrum added tests rustdoc.
• @MarkMcCaskey updated unimplemented! docs.
• @steveklabnik deprecated several flags in rustdoc.
• @GuillaumeGomez stabilised compile_fail, added deref suggestion, fixed rendering of const keyword for functions and added display of cfg in rustdoc.

Recent doc contributions

• @ishitatsuyuki made unused-extern-crate warn-by-default.
• @llogiq added a lowercase suggestion to unknown_lints.
• @oli-obk added clippy as a submodule, `](https://github.com/rust-lang/rust/pull/44059).
• @mystor removed highlight of # which does not start an attribute in rustdoc.
• @nrc improved the Pulldown/hoedown warnings.
• @mattico fixed link in unstable book entry for Generators.
• @frewsxcv expandws docs of multi-address behavior of some UDP/TCP APIs, fixed typo in doc ToSocketAddrs example and rewrote std::net::ToSocketAddrs doc examples.
• @lukaramu fixed release notes on associated constants.
• @Phlosioneer fixed typo in 1.20.0 release notes.
• @daboross clarified that VecDeque::swap can panic.
• @GuillaumeGomez added warnings when rustdoc html rendering differs, updated html-diff-rs version, fixed invalid display of enum sub-fields docs and fixed invalid linker position.

Meetings

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