This Week in Rust Docs 43

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 Guillaume Gomez.

Latest news

The rustdoc --test output has been updated. Now it looks like this (or at least it’ll when #39743 will get merged):

> rustdoc --test some_file.rs
the/path/some_file.rs - Foo::foo (line 43) ... ok
the/path/some_file.rs - Foo::bar (line 79) ... ok

Please take a look to the next rust doc days planning reminder.

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 two big issues for Rust documentation:

They all need help to move forward so any contribution is very welcome!

There are currently around 70 other documentation issues opened. Look for A-docs tagged issues on GitHub!

Waiting for merge

@keeperofdakeys added notes about capacity effects to Vec::truncate().
@frewsxcv documented the return value of zero-size/zero-heap pointer types.
@shepmaster improved grammar on field init docs and removed duplicated “parameter” in E0089 text.
@Rufflewind resolved ambiguities in the Generics in the Book.
@JordiPolo substituted try! for ? in the Result documentation.
@jimmycuadra included a stability span only if needed in rustdoc.
@Dowwie updated attributes.md - Last sentence updated to reflect support for custom attributes.
@estebank cleaned up “pattern doesn’t bind x” messages.
@notriddle added the item type to the tooltip.
@ollie27 showed attributes on all item types in rustdoc.
@zackmdavis used help rather than span note for no method error; a slight rephrasing.
@oli-obk distinguished guesses from suggestions.
@jrmuizel removed obsolete documentation about drop-flags.
@APTy added docs and tests for join_multicast_{v4,v6}.
@GuillaumeGomez added tested item in the rustdoc –test output, added missing urls and small nits and fixed invalid module suggestion.

Recent doc contributions

@zackmdavis improved error message when two-arg assert_eq! receives a trailing comma.
@keeperofdakeys gave a better error message for unknown derive messages.
@cengizIO improved error message for uninferrable types #38812.
@JordiPolo changed deprecation warning to indicate custom derive support was removed.
@nagisa expanded documentation of process::exit and exec.
@mgattozzi fixed full path being output with rustdoc -h.
@rspeer fixed a misleading statement inIterator.nth().
@bluecereal updated if-let.md.
@phungleson fixed short hand struct doc and removed suggestions to use things which weren’t found either.
@chriskrycho documented RFC 1623: static lifetime elision..
@durka removed lie about #[cfg] from reference and changed span_notes to notes in E0368/E0369.
@brson updated 1.15.1 relnotes.
@sgrif explicitly mentioned that Vec::reserve is based on len not capacity.
@Aaronepower updated nightly book with installing nightly instructions.
@jethrogb updated set operations documentation.
@ollie27 improved impl disambiguation in rustdoc.
@Gheoan added missing comma.
@steveklabnik re-wrote the doc index page.
@GuillaumeGomez added Debug implementations for libcollection structs, displayed correct filename with –test option, added missing urls on join_paths and added missing urls for current_dir.

Meetings

Next meeting will be on Wednesday 15th of February 2017 at 20:00 GMT on #rust-docs channel on irc.mozilla.org. Feel free to come!

Written on February 12, 2017