This Week in Rust Docs 20

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 Matthew Piziak.

Latest news (getting a bit old but still gold!)

Please take a look to the next rust doc days planning reminder.

The topic to propose crates for the Rust Doc Days is still open and waiting for contributions here. Please take a look!

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 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

@matthew-piziak added links to interesting items in std::ptr documentation and refactored range examples
@frewsxcv indicated where core::result::IntoIter is created
@steveklabnik made it clear that reference isn’t normative
@ollie27 fixed associated consts in search results
@GuillaumeGomez fixed formatting generation for rustdoc code examples and added missing urls
@Cobrand added mention of make tidy
@c4rlo fixed a “\” in a table heading to be “/”
@apasel422 cleaned up thread-local storage docs

Recent doc contributions

This week (too), I’ll split between the new error code format contributions and the others. Let’s start by the first one:

Other contributions:

@matthew-piziak improved documentation for Fn* traits, added evocative examples for Shl and Shr, added evocative examples for BitOr and BitXor, replaced BitAndAssign example with something more evocative, improved BitAnd trait documentation, added a simple example for thread::current(), implemented accumulate vector and assert for RangeFrom and RangeInclusive examples, showed how iterating over RangeTo and RangeToInclusive fails, and demonstrated RHS != Self use cases for Add and Sub
@F001 fixed documentation in the cell module
@regexident updated a code sample in chapter on syntax extensions
@frewsxcv noticed that rustbook chapters/sections should be ordered lists
@tshepang made the TcpListener example more simple
@dns2utf8 updated the man pages
@fanzier fixed a typo in PartialOrd docs
@wdv4758h changed rustc::plugin to rustc_plugin in a doc comment
@birkenfeld explained why Box/Rc/Arc methods do not take self
@GuillaumeGomez improved Path and PathBuf docs
@durka indicated where to copy config.toml.example
@skade documented try!’s error conversion behavior

Meetings

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

Written on September 5, 2016