This Week in Rust Docs 12
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, we decided that the RFC “More api documentation conventions” was ready to get merged. We now wait for the core team confirmation.
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
- @Manishearth clarified UnsafeCell docs.
- @estebank added a specific error message for missplaced doc comments.
- @GuillaumeGomez added libsyntax error code explanations.
Recent doc contributions
- @alexandermerritt made docs for clone_from_slice consistent with copy_from_slice.
- @ubsan added more docs to std::mem::transmute, fixed ABI string docs in reference.md and fixed ABI string docs in reference.md.
- @rdotdk updated a cargo doc link.
- @frewsxcv fixed a broken markdown link in README, improved primitive integers documentation, fixed an unnecessarily mutable reference in doc example and added doc examples for
io::Error::from_raw_os_error. - @Xmasreturns updated glossary.md.
- @jaredmanning fixed spacing in for loop enumeration example.
- @sylvestre fixed typos.
- @durka documented DoubleEndedIterator::next_back.
- @GuillaumeGomez, added examples for std::Error module, improved std::any module doc, added missing examples for std::cell types, removed an invalid CSS rule for doc titles, improved boxed docs, improved slice docs. fixed
std::path::Path::file_name()doc, removed an useless doc comment for slice and improved DoubleEndedIterator examples. - @llogiq improved the internal documentation of HIR
Meetings
Next meeting will be on Wednesday 13th of July 2016 at 20:00 GMT on #rust-docs channel on irc.mozilla.org. Feel free to come!