This Week in Rust Docs 18

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

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, replaced BitAnd example with something more evocative of bitwise AND, demonstrated that RHS != Self use cases for Add and Sub, added evocative examples for Shl and Shr, replaced Rem example with something more evocative, replaced Mul example with something more evocative of multiplication, replaced Index example with something more evocative of indexing, made more evocative examples for Sub and SubAssign, replaced println! statements with assert!ions in std::ptr examples, added example for Rc::would_unwrap, 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.
@CryZe fixed “Furthermore” Typo in String Docs.
@alevy fixed a minor typo in CONTRIBUTING.md.
@munyari added reference to Self in traits chapter (book).
@frewsxcv indicated where core::result::IntoIter is created and made various refactorings in the rustdoc module.
@Stebalien clarified/fixed formatting docs concerning fmt::Result/fmt::Error.
@jhod0 added diagnostics for rustc_metadata.
@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 improved Path and PathBuf docs, added new error code tests 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 Neg example with something more evocative of negation, replaced Not example with something more evocative, replaced AddAssign example with something more evocative of addition, demonstrated RHS != Self use cases for Mul and Div, replaced Add example with something more evocative of addition.
@terrynsun updated E0207 label to report parameter type.
@CryZe improved No stdlib and related documentation.
@crypto-universe updated test for E0221.
@ErikUggeldahl fixed very minor spelling typo in The Book.
@cantino fixed minor typo.
@wdv4758h fixed incorrect label messages for missing unsafe blocks (E0133).
@frewsxcv added a few doc examples for std::ffi::OsStr.
@ollie27 fixed a couple of issues with search results in rustdoc.
@jonathandturner fixed wording in error messages and moved ‘doesn’t live long enough’ errors to labels.
@GuillaumeGomez added new error code tests and fixed issue #11004.

Meetings

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

Written on August 22, 2016