This Week in Rust Docs 13
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 “More api documentation conventions” RFC has been merged!
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
- @durka documented DoubleEndedIterator::next_back.
- @shepmaster improved {String,Vec}::from_raw_parts documentation.
- @xitep made
.enumerate()
example self-explanatory. - @frewsxcv indicated where
std::slice
structs originate from and partially rewrote/expandedVec::truncate
documentation. - @Manishearth clarified UnsafeCell docs.
- @estebank added a specific error message for missplaced doc comments.
- @GuillaumeGomez added examples for VecDeque and added examples for LinkedList.
Recent doc contributions
- @ollie27 fixed methods in seach results in rustdoc.
- @alexandermerritt made docs for
clone_from_slice
consistent withcopy_from_slice
. - @izgzhen improved arc doc.
- @davidko fixed a few typos in The Book.
- @glandium added a mention to the fact that writeln! and println! always use LF.
- @wuranbo fixed ffi referenced rust-snappy which couldn’t compile.
- @frewsxcv added where
std::vec
structs originate from, made variousstd::process
doc and added doc example forstd::process::ExitStatus::success
. - @steveklabnik fixed up documentation around no_std.
- @tshepang made a few doc fixes.
- @GuillaumeGomez added examples for FpCategory and added libsyntax error code explanations.
Meetings
Next meeting will be on Wednesday 20th of July 2016 at 20:00 GMT on #rust-docs channel on irc.mozilla.org. Feel free to come!