This Week in Rust Docs 16

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

The doc team RFC has entered its final comment period!

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

@qolop fixed typo (privledge->privilege).
@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 fixed formatting generation for rustdoc code examples

Recent doc contributions

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

Others contributions:

@dns2utf8 added doc for std::thread::park_timeout.
@shantanuraj updated wording on E0080.
@apasel422 added doc example for std::ffi::NulError::nul_position, cleaned up std::raw docs.
@frewsxcv added doc example for std::ffi::NulError::into_vec, made a couple std::net doc improvements, rewrote rewrite slice::chunks doc example to not require printing, 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.
@Manishearth clarified UnsafeCell docs.
@GuillaumeGomez added doc examples for FileType struct, added io::Error doc examples, added doc example for Vec, added new error codes and added even more error code tests and added even even more error code tests.

Meetings

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

Written on August 8, 2016