This Week in Rust Docs 14
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
A topic to propose crates for the Rust Doc Days has been created here.
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
- @qolop fixed typo (privledge->privilege).
- @jhod0 added diagnostics for rustc_metadata.
- @abhijeetbhagat updated underscore usage and updated VecDeque documentation to specify direction of index 0.
- @rdwilliamson fixed HashMap’s values_mut example to use println!.
- @nrc simplified rustdoc URLs.
- @durka documented DoubleEndedIterator::next_back.
- @Manishearth clarified UnsafeCell docs.
- @estebank added a specific error message for missplaced doc comments.
- @ollie27 removed item types from some title pages from rustdoc.
- @frewsxcv rewrote/expanded
slice::split
doc examples. - @GuillaumeGomez fixed formatting generation for rustdoc code examples, improved
DirEntry
doc, added DirBuilder doc examples, added HashMap Entry enums examples and improvedOpen
doc.
Recent doc contributions
- @mark-buer removed rustdoc reference to
walk_dir
. - @wettowelreactor fixed some typos in char.rs.
- @frewsxcv rewrote/expanded doc examples for
Vec::set_len
, improved doc examples forslice::windows
, added doc examples forVec::{as_slice,as_mut_slice}
, indicated wherestd::slice
structs originate from and partially rewrote/expandedVec::truncate
documentation. - @xitep made
.enumerate()
example self-explanatory. - @shepmaster improved {String,Vec}::from_raw_parts documentation.
@GuillaumeGomez fixed Fix unwanted top margin for toggle wrapper in rustdoc CSS, added doc for btree_map types, added
BuildHasher
examples, addedRandomState
doc, added examples for VecDeque and added examples for LinkedList.
Meetings
Next meeting will be on Wednesday 27th of July 2016 at 20:00 GMT on #rust-docs channel on irc.mozilla.org. Feel free to come!