This Week in Rust Docs 26
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:
- 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
- @frewsxcv improved doc example for
std::borrow::Cow. - @nabeelomer updated the docs for Error::description.
- @QuietMisdreavus added line breaks to where clauses a la rustfmt.
- @sinkuu made E0243/E0244 message consistent with E0107.
- @steveklabnik made it clear that reference isn’t normative.
- @GuillaumeGomez added more tags display in rustdoc, added missing urls for io types, added invalid doc comment help message, added missing urls on Vec docs, added information in case of markdown block code test failure and fixed formatting generation for rustdoc code examples.
Recent doc contributions
- @ollie27 improved playground run buttons in rustdoc.
- @est31 colored the question mark operator in the rustdoc output.
- @jfirebaugh updated E0303 to new error format.
- @Razican improved playground run buttons in rustdoc.
- @nabeelomer documented that RwLock might panic.
- @durka removed backticks in Type Aliases header in The Book.
- @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.
- @GuillaumeGomez added missing urls in io module, added missing urls on String module, added missing urls for BufWriter and BufReader, added missing urls in slice doc module and added missing urls for hash modules.
Meetings
Next meeting will be on Wednesday 17th of October 2016 at 20:00 GMT on #rust-docs channel on irc.mozilla.org. Feel free to come!