This Week in Rust Docs 41

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

@Wilfred made a minor grammar fix ‘can not’ -> ‘cannot’.
@cengizIO improved error message for uninferrable types.
@mgattozzi added clearer error message using &str + &str and fixed full path being output with rustdoc -h.
@durka removed lie about #[cfg] from reference.
@canndrew added warning for () to ! switch.
@zackmdavis added a note for individual lint name in messages set via lint group attribute.
@jrmuizel removed obsolete documentation about drop-flags.
@estebank highlighted code in rustc --explain.
@federicomenaquintero clarified the lack of mutability inside an Rc in std:rc.
@rspeer fixed a misleading statement in Iterator.nth().
@GuillaumeGomez added information in case of markdown block code test failure.

Recent doc contributions

@frewsxcv added more references between lowercase/uppercase operations. and added doc examples for std::ffi::OsString fucntions/methods..
@steveklabnik fixed wording around sort guarantees.
@DirkyJerky added docs for atomic orderings: link to the ‘nomicon article for further reading.
@cesarb updated The Book: size and align in trait object vtables are used.
@linclark added error explanation for E0328.
@jtxx000 fixed typo in librustc_trans/collector.rs.
@osa1 fixed typos in libsyntax/tokenstream.rs.
@brson removed all “consider using an explicit lifetime parameter” suggestions.
@stjepang rewrote the first sentence in slice::sort.
@ollie27 fixed a few links in the docs.
@king6cong made a doc comment typo fix, reworded a doc comment rewording and improved a comment wording.
@estebank pointed to immutable arg/fields when trying to use as &mut and fixed multiple labels when some don’t have message.
@das-g fixed book: refer to add_two as “tested function”.
@ConnyOnny updted match enum warning in The Book.
@Wilfred added missing URL to release notes.
@Eijebong fixed minor typo.
@utkarshkukreti replaced all try! with ? in documentation examples.
@GuillaumeGomez added missing urls for OsStr and OsString, forced backline on all where in docs, removed doc generation if doc comments only filled with ‘white’ characters, added note for E0117, added a distinct error code and description for “main function has wrong type” and added missing urls for array docs.

Meetings

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

Written on January 29, 2017