This Week in Rust Docs 38

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 three 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

@chris-morgan fixed a couple of bad Markdown links and fixed rustdoc highlighting of & and *.
@petrochenkov resolved: do not use “resolve”/”resolution” in error messages.
@estebank suggested solutions for fn foo(&foo: Foo), removed note: prefix from type mismatch errors and escaped the deprecated and unstable reason text in rustdoc.
@steveklabnik improved safety warning on ptr::swap.
@liigo added suggestions of #[macro_use] in every case for undefined macros.
@frewsxcv expanded {Path,OsStr}::{to_str,to_string_lossy} doc examples., clarified behavior of VecDeque::insert. and clarified zero-value behavior of ctlz/cttz intrinsics..
@Manishearth improved rustdoc rendering for unstable features and added more docs for CoerceUnsized and Unsize.
@nagisa expanded documentation of process::exit and exec.
@derekdreery updated vec.rs.
@linclark add error explanation for E0328..
@shahn clarified Extend behaviour wrt existing keys.
@F001 updated usage of rustc.
@emilio added an attribute to ignore collecting tests per-item in rustdoc.
@ShaunKarran fixed docs for TcpListener example.
@ollie27 fixed typo in tuple docs.
@Freyskeyd improved doc for cfg(test) and tests directory.
@cbreeden updated sign formatting for numeric types in docs.
@rkruppe replaced loop {} with abort() in The Book.
@bombless fixed doc for escape_debug.
@chriskrycho documented RFC 1623: static lifetime elision..
@GuillaumeGomez added a distinct error code and description for “main function has wrong prototype”, added instant doc, fixed invalid module suggestion, added ref suggestion and added information in case of markdown block code test failure.

Recent doc contributions

@estebank disambiguated Implementors when the type name is not unique in rustdoc.
@jonathandturner fixed E0088/E0090.
@sanxiyn removed rustdoc ICE when an unstable feature is used.
@steveklabnik documented custom derive.
@clarcharr reworded ‘stupid’ and ‘crazy’ in docs.
@programble added links to methods on all slice iterator struct docs.
@GuillaumeGomez added missing example for Thread struct.

Meetings

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

Written on January 8, 2017