This Week in Rust Docs 29
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:
- Error code list which need to be updated to new format
- The Standard Library Documentation Checklist
- Add error explanations for all error codes
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
- @johnthagen added example using Self to reference.
- @brson added changelog for 1.13.0, and removed all “consider using an explicit lifetime parameter” suggestions.
- @estebank fixed invalid “ref mut mut” sugestion and provided hint when cast needs a dereference.
- @mikhail-m1 improved “Doesn’t live long enough” error.
- @liigo marked unsafe fns in module page with superscript icons in rustdoc.
- @xfix matched guessing game output to newest language version.
- @steveklabnik made it clear that the reference isn’t normative.
- @joshtriplett documented convention for using both fmt::Write and io::Write.
- @jfirebaugh removed long diagnostic for E0002 and added a distinct error code and description for “main function has wrong type”.
- @sinkuu made E0243/E0244 message consistent with E0107.
- @GuillaumeGomez added missing urls on io structs, started implementation of proposal for E0308, improved reference cast help message and printed more tags in rustdoc.
Recent doc contributions
- @joshtriplett copied/edited on documentation for write! and writeln!.
- @AndiDog added E0532 error explanation.
- @Cobrand improved docs for Index and IndexMut.
- @mikhail-m1 improved “Doesn’t live long enough” error.
- @ollie27 fixed a few links in the docs.
- @d-unseductable elided lifetimes in DerefMut documentation.
- @pfrenssen updated “Testing” chapter for 1.12.
- @xfix removed mention of “*” dependency version in guessing game example.
- @diwic fixed str documentation typo.
- @GuillaumeGomez added missing urls for ErrorKind’s variants.
Meetings
Next meeting will be on Wednesday 9th of November 2016 at 20:00 GMT on #rust-docs channel on irc.mozilla.org. Feel free to come!