This Week in Rust Docs 40

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

@frewsxcv added more references between lowercase/uppercase operations..
@steveklabnik fixed wording around sort guarantees.
@bluecereal updated if-let.md.
@nagisa expanded documentation of process::exit and exec.
@DirkyJerky added docs for atomic orderings: link to the ‘nomicon article for further reading.
@rspeer fixed a misleading statement in Iterator.nth().
@cesarb updated The Book: size and align in trait object vtables are used.
@apasel422 updated nomicon to describe #[may_dangle].
@APTy added docs and tests for join_multicast_{v4,v6} for UDP socket.
@linclark added error explanation for E0328.
@Freyskeyd improved doc cfg(test) and tests directory.
@insaneinside updated src/libcore/ops.rs docs for RFC#1228 (Placement Left Arrow).
@GuillaumeGomez added missing urls for OsStr and OsString, added information in case of markdown block code test failure, forced backline on all where in docs, added ref suggestion and fixed invalid module suggestion.

Recent doc contributions

@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, added ‘platform-specific’ section to sleep_ms to match sleep, added doc examples for std::ffi::OsString fucntions/methods, made a few improvements to the slice docs and made improvements to ‘include’ macro documentation.
@brson added 1.15 release notes.
@federicomenaquintero documented the optional extra arguments to assert_eq!() / assert_ne!().
@chris-morgan fixed a couple of bad Markdown links.
@ranma42 documented that Metadata can be obtained from symlink_metadata.
@TheCycoONE clarified when range is removed by drain.
@grimreaper fixed a minor typo.
@king6cong improved doc wording.
@richard-imaoka added error explanation for E0491.
@GuillaumeGomez fixed missing blank space issue and specified the result of integer cast on boolean.

Meetings

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

Written on January 22, 2017