This Week in Rust Docs 17
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: GuillaumeGomez.
Latest news
The doc team RFC has been merged. The rust doc team is now official! Take a look here.
Please take a look to the next rust doc days planning reminder.
A new RFC has been opened: Add API documentation front page styleguide.
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 50 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
- @jhod0 added diagnostics for rustc_metadata.
- @estebank added a specific error message for misplaced doc comments.
- @ollie27 removed item types from some title pages from rustdoc.
- @steveklabnik made it clear that the reference isn’t normative.
- @GuillaumeGomez centered content of the generated docs, added new error code tests and fixed formatting generation for rustdoc code examples
Recent doc contributions
This week, I’ll split between the new error code format contributions and the others. Let’s start by the first one:
- @munyari: E0214, E0038
- @garekkream: E0162, E0302, E0301
- @hank-der-hafenarbeiter: E0221, E0045, E0433
- @razielgn: E0026
- @srdja: E0007 and E0008
- @Vassah: E0091 and E0092
- @clementmiao: E0067, E0070
- @crypto-universe: E0254
- @shyaamsundhar: E0248, E0267 and E0268
- @circuitfox: E0072, E0128
- @wdv4758h: E0138, E0133
- @lukehinds: E0253
- @Limeth: E0263
- @theypsilon: E0384, E0094
Others contributions:
- @IvanUkhov fixed a couple of typos in RawVec.
- @pietroalbini: fixed docs typo in std::os::unix::net::SocketAddr::is_unnamed.
- @matthew-piziak fixed small typos in std::convert documentation.
- @cvubrugier fixed the hidden find() functions in The Book.
- @tshepang fixed
&strcalling in the doc. - @qolop fixed typo (privledge->privilege).
- @GuillaumeGomez fixed E0132 error display and added new error code tests.
Meetings
Next meeting will be on Wednesday 17th of August 2016 at 20:00 GMT on #rust-docs channel on irc.mozilla.org. Feel free to come!