This Week in Rust Docs 22

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 Guillaume Gomez.

Latest news

The “new” run button has been merged and is now used in nightly docs. Give it a try!

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

@christopherdumas updated includes! documentation.
@Mark-Simulacrum links between format_args! macro and std::fmt::Arguments struct](https://github.com/rust-lang/rust/pull/36523).
@EdorianDark inserted examples with universal function call syntax.
@frewsxcv added basic doc examples for std::panic::{set_hook, take_hook} and added basic doc example for std::panic::set_hook.
@matthew-piziak added links to interesting items in std::ptr documentation, refactored range examples and added default docstrings for String, AtomicBool, and Generics.
@steveklabnik made it clear that reference isn’t normative.
@GuillaumeGomez added information in case of markdown block code test failure, added metadata diagnostics, 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:

Other contributions:

@kmcallister tweaked std::mem docs, tweaked array docs and tweaked std::marker docs.
@Mark-Simulacrum fixed language in documentation comment, added example in AsMut trait documentation.
@kylog fixed a typo in The Book.
@tshepang improved wording.
@athulappadan added Documentation about what Default does for each type.
@liigo removed the docblock-short collapse.
@kylog fixed a typo in The Book.
@dangcheng fixed a mistake (File::open -> File::create) in The Book.
@c4rlo fixed a “\” in a table heading to be “/”.
@GuillaumeGomez added urls when they were needed and set run button transparent instead of invisible.

Meetings

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

Written on September 18, 2016