This Week in Rust Docs 27

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 way rustdoc is creating urls is problematic for the moment. A good summary of this issue can be found here. A few members of the Rust Doc team are preparing an RFC in order to improve this. If you want to get involved, feel free to speak about it with Guillaume Gomez (imperio on IRC).

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

@bluss added documentation for Read, Write impls for slices and Vec.
@sinkuu made E0243/E0244 message consistent with E0107.
@brson added release notes for 1.12.1 and removed all “consider using an explicit lifetime parameter” suggestions.
@ollie27 fixed a few links in the docs.
@liigo is working on rustdoc: flag unsafe fns in module’s function list.
@phungleson updated E0072 bonus to new error format.
@jfirebaugh added a distinct error code and description for “main function has wrong type” and removed long diagnostic for E0002.
@QuietMisdreavus rustdoc: add line breaks to where clauses a la rustfmt.
@loggerhead fixed an error of ‘book/deref-coercions.html’.
@steveklabnik made it clear that the reference isn’t normative.
@diwic fixed documentation typo.
@GuillaumeGomez Improve E0277 help message, Add missing urls in collections module, Add information in case of markdown block code test failure and Print more tags in rustdoc.

Recent doc contributions

@frewsxcv improved doc example for std::borrow::Cow.
@nabeelomer updated the docs for Error::description.
@aidanhs as_bytes is not the iterator on String, bytes is.
@tshepang added a simpler description of Iterator::nth.
@vkatsikaros made a minor clarification in guessing game.
@senior added error explaination for E0182, E0230 and E0399.
@mikhail-m1 improved “Doesn’t live long enough” error.
@ollie27 rustdoc: Improve playground run buttons.
@zackmdavis corrected erroneous pluralization of ‘1 type argument’ error messages.
@jethrogb added stable example to TypeId.
@GuillaumeGomez added missing urls for io types, added invalid doc comment help message, added missing urls on Vec docs, Rollup of 10 pull requests, Rollup of 7 pull requests, Add more io urls and Rollup of 6 pull requests.

Meetings

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

Written on October 23, 2016