This Week in Rust Docs 11
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
In the last team meeting (renamed “schrodinger’s doc meeting”, thanks for the idea @jonathandturner!), we mainly talked about The Rust Doc Days. The feedback is globally good but I’ll let read the great post that @peschkaj wrote about it.
Current opened issues
For now, here are the two big issues for Rust documentation:
They both 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
- @sylvestre fixed typos.
- @jaredmanning fixed spacing in for loop enumeration example.
- @Xmasreturns updated glossary.md.
- @frewsxcv fixed broken markdown link in README and added doc examples for
io::Error::from_raw_os_error
. - @rdotdk updated cargo doc link.
- @Manishearth clarified UnsafeCell docs.
- @ubsan added more docs to std::mem::transmute, fixed ABI string docs in reference.md and fixed ABI string docs in reference.md.
- @estebank added specific error message for missplaced doc comments.
- @GuillaumeGomez added libsyntax error codes explanation.
Recent doc contributions
- @jupp0r improved code example for try!.
- @jonmarkprice made small grammatical and stylistic edits to The Book.
- @tatsuya6502 fixed links in Ownership section of the book.
- @dns2utf8 added example with leading zeros.
- @frewsxcv expanded
std::path::Component
documentation, added doc example forstd::io::sink
, added doc example forstd::io::repeat
, made a minor rewrite ofstd::io::empty
doc example and added example forstd::thread::sleep
. - @ollie27 fixed inlined renamed reexports in import lists, fixed a few stripping issues in rustdoc, fixed float examples, fixed search result layout for enum variants and struct fields, fixed empty Implementations section on some module pages in rustdoc and removed Remove Derived Implementations title.
- @GuillaumeGomez fixed E0269 explanation, added error codes in libsyntax and added new error codes and improve some explanations.
Meetings
Next meeting will be on Wednesday 6th of July 2016 at 20:00 GMT on #rust-docs channel on irc.mozilla.org. Feel free to come!