This Week in Rust Docs 25

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

@KillTheMule made explicit the fact that lifetime are descriptive.
@frewsxcv refactored and cleaned up rustdoc.
@QuietMisdreavus updated rustdoc to print non-self arguments of bare functions and struct methods on their own line.
@sinkuu made E0243/E0244 message consistent with E0107.
@steveklabnik made it clear that reference isn’t normative.
@GuillaumeGomez added invalid doc comment help message, added missing urls on Vec docs, added missing urls in slice doc module, added missing urls for hash modules, added information in case of markdown block code test failure and fixed formatting generation for rustdoc code examples.

Recent doc contributions

@chamoysvoice updated E0220 error format.
@ollie27 fixed missing *mut T impl in rustdoc.
@acrrd made a better underline for E0057, E0060 and E0061.
@angelsl mentioned move keyword for lambdas in Reference and clarified last element in str.{r,}splitn documentation.
@wesleywiser fixed documentation for write! on std::fmt page.
@frewsxcv made a “minor” librustdoc cleanup and refactoring.
@BlueSpaceCanary removed the double introduction for cargo run.
@gavinb improved error message and snippet for “did you mean x”.
@kmcallister updated Arc docs to match new Rc docs.
@christopherdumas updated includes! documentation.
@GuillaumeGomez fixed run button appearing when it shouldn’t, merged E0002 into E0004, added missing urls for error module, fixed typos and removed underline when run button hovered.

Meetings

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

Written on October 9, 2016