This Week in Rust Docs 28

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

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

@joshtriplett copied/edited on documentation for write! and writeln! and documented convention for using both fmt::Write and io::Write.
@AndiDog added E0532 error explanation.
@liigo added an unsafe sign for unsafe functions in module page with superscript icons.
@achanda clarified that send_to might panic in certain cases.
@Cobrand improved docs for Index and IndexMut.
@polo-language added error note to illegal code snippet.
@jfirebaugh removed long diagnostic for E0002 and added a distinct error code and description for “main function has wrong type”.
@mikhail-m1 improved “Doesn’t live long enough” error.
@sinkuu made E0243/E0244 message consistent with E0107.
@brson removed all “consider using an explicit lifetime parameter” suggestions and added release notes for 1.12.1.
@ollie27 fixed a few links in the docs.
@phungleson updated E0072 bonus to new error format.
@johnthagen added example using Self to reference.
@GuillaumeGomez started the implementation of proposal for E0308, improved reference cast help message, added information in case of markdown block code test failure and printed more tags in rustdoc.

Recent doc contributions

@bluss added documentation for Read, Write impls for slices and Vec.
@loggerhead fixed an error of ‘book/deref-coercions.html’.
@mcarton fixed bad error message with ::< in types.
@robinst added semicolon to “Maybe a missing extern crate foo” message.
@zoffixznet fixed typo.
@mikhail-m1 made error E0221 more helpful.
@vtduncan fixed broken links in Vec docs and added link to PathBuf from the Path docs.
@typelist fixed typo that resulted in comparison-to-self.
@aidanhs as_bytes is not the iterator on String, bytes is.
@GuillaumeGomez improved E0277 help message and added missing urls in collections module.

Meetings

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

Written on October 30, 2016