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

• @QuietMisdreavus included external files in documentation in rustdoc (RFC 1990), showed in docs whether the return type of a function impls Iterator/Read/Write, added talk about #![doc(test(no_crate_inject))] and #![doc(test(attr(…)))] in rustdoc and tweaked notes on ignore/compile_fail examples in rustdoc.
• @Aaronepower updated Release notes for 1.22.0.
• @estebank highlighted code on diagnostics when underlined.
• @steveklabnik started shipping the Cargo book.
• @fhartwig made rustdoc not include self-by-value methods from Deref target.
• @JRegimbal change “Types/modules” title of search tab to be more accurate.
• @pornel remove deprecated message.
• @GuillaumeGomez added search over generic types in docs.

Recent doc contributions

• @QuietMisdreavus added #[allow(unused)] to every doctest in rustdoc.
• @Havvy updated reference link in doc’s 404.
• @topecongiro fixed typos in README.md.
• @sdroege updated the std::thread docs and clarified that panics can nowadays be caught.
• @ollie27 fixed duplicated impls with generics in rustdoc.
• @lukaramu fixed broken link markup in Hasher::finish docs.
• @xfix allowed a trailing comma in assert_eq/ne macro.
• @jhford updated get() example: it should use get() not get_mut().
• @estebank fixed help for duplicated names: extern crate (...) as (...) and detected = -> : typo in let bindings.
• @Badel2 added error for ... in expressions.
• @GuillaumeGomez added missing links and examples, added missing docs for MetadataExt, added more elements in the sidebar, added missing links and examples for FileExt, fixed navbar click while in a search, added missing example for Debug trait and added ”-“ shortcut in rust docs.

Meetings

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