This Week in Rust Docs 39

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

@Manishearth improved rustdoc rendering for unstable features! The rendering is available on nightly docs.

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

@ollie27 gave primitive types stability attributes in rustdoc.
@radix made a minor improvement to strange grammar in E0525.
@frewsxcv added doc examples & description in std::os::unix::ffi., made minor improvements to docs in std::env structures/functions. and added ‘platform-specific’ section to sleep_ms to match sleep..
@jmdyck added a link to the second edition of The Book.
@steveklabnik fixed wording around sort guarantees.
@estebank taught diagnostics to highlight text and provided disambiguated syntax for candidates in E0034.
@APTy added docs and tests for join_multicast_{v4,v6}.
@brson added 1.15 release notes and removed all “consider using an explicit lifetime parameter” sug….
@federicomenaquintero documented the optional extra arguments to assert_eq!() / assert_ne!().
@emilio added an attribute to ignore collecting tests per-item in rustdoc.
@chris-morgan fixed a couple of bad Markdown links.
@insaneinside updated src/libcore/ops.rs docs for RFC#1228 (Placement Left Arrow).
@nagisa expanded documentation of process::exit and exec.
@linclark added error explanation for E0328..
@chriskrycho documented RFC 1623: static lifetime elision..
@utkarshkukreti replaced all try! with ? in documentation examples.
@ConnyOnny added warning for match enum in The Book.
@GuillaumeGomez fixed missing blank space issue, added information in case of markdown block code test failure, added a distinct error code and description for “main function has wrong prototype, added ref suggestion and fixed invalid module suggestion.

Recent doc contributions

@chris-morgan fixed rustdoc highlighting of & and *.
@petrochenkov fixed docs for min/max algorithms.
@estebank escaped the deprecated and unstable reason text in rustdoc and taught diagnostics to correct margin of multiline messages.
@steveklabnik improved safety warning on ptr::swap.
@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, added more docs for CoerceUnsized and Unsize and removed restrictions on docs in compiler-docs mode.
@F001 updated usage of rustc.
@ollie27 fixed typo in tuple docs.
@stjepang changed to_owned to to_string in docs.
@est31 added tidy check for lang gate tests.
@behnam fixed typo in documentation.
@BenWiederhake fixed some typos in Nomicon.
@minaguib fixed docs.
@GuillaumeGomez added instant doc, added missing doc examples for Mutex and added missing links and examples for path modules and structs.

Meetings

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

Written on January 15, 2017