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: GuillaumeGomez.

Latest news

A new RFC has been opened: Add API documentation front page styleguide.

A topic to propose crates for the Rust Doc Days has been created here. Please take a look!

Current opened issues

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

• The Standard Library Documentation Checklist
• Add error explanations for all error codes

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

There are currently around 50 other documentation issues opened. Look for A-docs tagged issues on github!

Call for participation

There’s now a call for participation to display all methods of a type, even those from implicit traits in rustdoc. This is a great way to help users find everything that a type can do. Any help on it would be very appreciated!

Waiting for merge

• @frewsxcv added doc examples for range::RangeArgument::{start,end} and rewrote slice::chunks doc example to not require printing.
• @jongiddy provide a more explicit example of wildcard version in guessing game doc.
• @qolop fixed typo (privledge->privilege).
• @jhod0 added diagnostics for rustc_metadata.
• @nrc simplified rustdoc URLs.
• @Manishearth clarified UnsafeCell docs.
• @estebank added a specific error message for misplaced doc comments.
• @ollie27 removed item types from some title pages from rustdoc.
• @steveklabnik made it clear that the reference isn’t normative.
• @GuillaumeGomez added doc examples for FileType struct, added io::Error doc examples and fixed formatting generation for rustdoc code examples.

Recent doc contributions

• @knight42 added more intuitive explanation of strings formatting.
• @munyari added docs for assert! and debug_assert!.
• @vadimcn fixed typos.
• @rdwilliamson fixed HashMap’s values_mut example to use println!.
• @abhijeetbhagat updated underscore usage and updated VecDeque documentation to specify direction of index 0.
• @durka documented DoubleEndedIterator::next_back.
• @frewsxcv rewrote/expanded slice::split doc examples.
• @frewsxcv rewrote collections::LinkedList::append doc example and added documentation example for str::Chars::as_str.
• @GuillaumeGomez added std::fs docs, improved DirEntry doc, added HashMap Entry enums examples, improved Open doc and added DirBuilder doc examples.

Meetings

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