Hello and welcome to This Week in Rust Docs and happy new year!

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:

• Stable
• Beta
• Nightly

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

• The Standard Library Documentation Checklist
• Add error explanations for all error codes

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

• @brson removed all “consider using an explicit lifetime parameter” suggestions.
• @estebank suggested solutions for fn foo(&foo: Foo), escaped the deprecated and unstable reason text in rustdoc, disambiguated Implementors when the type name is not unique in rustdoc and provide disambiguated syntax for candidates in E0034.
• @frewsxcv clarified behavior of VecDeque::insert, made improvements to ‘include’ macro documentation and clarified zero-value behavior of ctlz/cttz intrinsics.
• @bombless fixed doc for escape_debug.
• @nagisa expanded documentation of process::exit and exec.
• @rkruppe replaced loop {} with abort() for panic in The Book.
• @chris-morgan fixed rustdoc highlighting of & and *.
• @linclark added error explanation for E0328.
• @birkenfeld update docs of slice get() and friends.
• @federicomenaquintero documented the optional extra arguments to assert_eq!() / assert_ne!().
• @GuillaumeGomez added ref suggestion, added missing example for Thread struct, added Instant doc, added information in case of markdown block code test failure in rustdoc and fixed invalid module suggestion.

Recent doc contributions

• @frewsxcv clarified phrasing of MSYS2 dependencies in README.md and documented foreign variadic functions in TRPL and the reference..
• @ollie27 fixed invalid HTML in stability notices in rustdoc and fixed broken CSS for trait items in rustdoc.
• @programble added links to methods on all slice iterator struct docs.
• @jseyfried fixed internal compiler error (ICE) in rustdoc.
• @lucis-fluxum fixed typo in PartialOrd docs.
• @agl added “an” before “i32” and add missing apostrophe..
• @kellerkindt and suddenly a german word :O.
• @GuillaumeGomez improved builder docs, added missing urls in Arc docs, add missing urls in AtomicBool docs, added missing urls for AtomicPtr, added missing urls for atomic_int macros types and added missing urls for atomic fn docs.

Meetings

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