This Week in Rust Docs 42
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
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
- @zackmdavis improved error message when two-arg assert_eq! receives a trailing comma and used help rather than span note for no method error; a slight rephrasing.
- @keeperofdakeys gave a better error message for unknown derive messages.
- @APTy added docs and tests for join_multicast_{v4,v6}.
- @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 in
Iterator.nth(). - @bluecereal updated if-let.md.
- @oli-obk distinguished guesses from suggestions.
- @estebank highlighted code in
rustc --explain, pointed to enclosing block/fn on nested unsafe and detected missing;on methods with return type(). - @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.
- @GuillaumeGomez fixed invalid module suggestion, added Debug implementations for libcollection structs and added missing urls and small nits.
Recent doc contributions
- @Wilfred made a minor grammar fix ‘can not’ -> ‘cannot’.
- @mgattozzi added clearer error message using
&str + &str. - @zackmdavis added a note for individual lint name in messages set via lint group attribute.
- @federicomenaquintero clarified the lack of mutability inside an Rc in std:rc.
- @alexcrichton suppressed warnings/errors with rustdoc –test.
- @brson updated relnotes for 1.15.1.
- @phungleson made a tiny doc wording change.
- @apasel422 updated nomicon to describe
#[may_dangle]. - @tspiteri marked FFI functions with unsafety icon in rustdoc.
- @Freyskeyd improved doc cfg(test) and tests directory.
- @tshepang made minor doc Option improvements.
- @GuillaumeGomez added information in case of markdown block code test failure, added missing urls in HashMap and added missing url in convert module.
Meetings
Next meeting will be on Wednesday 8th of February 2017 at 20:00 GMT on #rust-docs channel on irc.mozilla.org. Feel free to come!