This Week in Rust Docs 21

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

In the last meetup, we discussed about the possibilty to “expand” examples in the doc in order to show the full code. The goal is to prevent issues from copy/paste where try/? are used.

Another thing was that it should be more obvious that the code examples could actually be run online. To this issue, a PR has already be opened here.

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

@athulappadan added Documentation about what Default does for each type.
@EdorianDark inserted examples with universal function call syntax.
@liigo removed the docblock-short collapse.
@kylog fixed a typo in The Book.
@dangcheng fixed a mistake (File::open -> File::create) in The Book.
@frewsxcv added basic doc example for std::panic::set_hook.
@c4rlo fixed a “\” in a table heading to be “/”.
@matthew-piziak added links to interesting items in std::ptr documentation and refactored range examples, added default docstrings for String, AtomicBool, and Generics and updated docstrings for mem::update and mem::swap.
@steveklabnik made it clear that reference isn’t normative.
@GuillaumeGomez added metadata diagnostics, added urls when they were needed, fixed formatting generation for rustdoc code examples and set run button transparent instead of invisible.

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:

@JDemler fixed typo in nomicon.
@fanzier fixed typo in PartialOrd docs.
@johnthagen updated nightly docs supported Windows versions to match Getting Started page.
@Sawyer47 removed incorrect methods inherited through Deref by filtering them.
@tshepang fixed doc coercion.
@frewsxcv indicated where core::result::IntoIter is created and added doc example for std::time::Instant::elapsed.
@ollie27 fixed associated consts in search results.
@Cobrand added mention of make tidy and added mention of make tidy into contributing.md file.
@apasel422 cleaned up thread-local storage docs.
@GuillaumeGomez added missing urls, added new error code tests, added missing urls here and here.

Meetings

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

Written on September 11, 2016