This Week in Rust Docs 65

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

@steveklabnik ended the first version of the rewrite of rustdoc using RLS. It’s far from done but don’t hesitate to give it a try!

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 T-doc tagged issues on GitHub!

Waiting for merge

@Emilgardis fixed wrong report on closure args mismatch when a ref is expected but not found.
@RalfJung clarified wording for E0122.
@afshinm added + sign to static lifetime help message.
@oli-obk adjusted new suggestions to the suggestion guidelines.
@waywardmonkeys fixed some doc comment typos.
@mandeep added generic example of std::ops::Sub in doc comments.
@xliiv added simple docs example for struct Cell.
@stjepang clarified that sort_unstable is deterministic.
@tshepang made into_iter example more concise.
@cuviper corrected the spelling of “homogeneous”.
@s3rvac added a missing verb to the description of std::process::ExitStatus::success().
@kennytm exposed all OS-specific modules in libstd doc.
@GuillaumeGomez added warnings when rustdoc html rendering differs, added lint for when doc comments are added where they’re unused and removed warn on unused field on union.

Recent doc contributions

@oli-obk changed some notes into suggestions.
@rthomas updated docs on Error struct.
@gaurikholkar reordered span suggestions to appear below main labels.
@Others improved panic docs for Instant::duration_since.
@tshepang provided an actual equivalent to filter_map doc.
@petrochenkov added an extra note to late_bound_lifetime_arguments error/lint.
@perryprog made a less verbose output for unused arguments.
@zackmdavis made JSON error byte position start at top of file, made explanatory error on --print target-spec-json without unstable options and suggested one-argument enum variant to fix type mismatch when applicable.
@Aaronepower updated release notes for 1.19.0.
@vbrandl documented default values for primitive types.

Meetings

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

Written on July 23, 2017