This Week in Rust Docs 19

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

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

@matthew-piziak improved documentation for Fn* traits, demonstrated that RHS != Self use cases for Add and Sub, added evocative examples for Shl and Shr, added links to interesting items in std::ptr documentation and added a panic example to std::from_utf8_unchecked.
@F001 fixed documentation in cell mod.
@frewsxcv indicated where core::result::IntoIter is created.
@Stebalien clarified/fixed formatting docs concerning fmt::Result/fmt::Error.
@steveklabnik made it clear that the reference isn’t normative.
@ollie27 fixed associated consts in search results in rustdoc.
@GuillaumeGomez added missing urls into convert module, improved Path and PathBuf docs and fixed formatting generation for rustdoc code examples.

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:

Others contributions:

@matthew-piziak replaced Div example with something more evocative of division, added example for Rc::would_unwrap, replaced println! statements with assert!ions in std::ptr examples, added more evocative examples for Sub and SubAssign, replaced Index example with something more evocative of indexing, replaced Rem example with something more evocative, replaced Mul example with something more evocative of multiplication, replaced BitAnd example with something more evocative of bitwise AND
@estebank added a specific error message for misplaced doc comments.
@frewsxcv made various refactorings in the rustdoc module.
@CryZe fixed “Furthermore” Typo in String Docs.
@alevy fixed a minor typo in CONTRIBUTING.md.
@munyari added reference to Self in traits chapter in The Book.
@kyrias improved E0094 underline.
@tshepang added trailing commas.
@GuillaumeGomez added new error code testshere and here.

Meetings

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

Written on August 29, 2016