This Week in Rust Docs 93

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

Hoedown is finally being removed from rustdoc! I’ll post the approval message from @QuietMisdreavus in here:

The preparations are complete. It is time…

Begone, demon of the foul C! Your presence is no longer wanted here! With this strike, I commit you to the depths of history, never to torment our fair land again!

You can see the pull request here.

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

@estebank reworded E0044 and message for !Send types, detected possibly non-Rust closure syntax during parse, suggested setting associated type when type argument is given instead and avoidED ICE in arg mistmatch error for tuple variants.
@partim improved documentation for Borrow, AsRef, and friends.
@dbrgn whitelisted based suggestions.
@vi added foldable impl blocks in rustdoc.
@wesleywiser fixed how paths are printed by error messages during bootstrap.
@Aaron1011 generated documentation for auto-trait impls.
@topecongiro fixed span of visibility.
@NovemberZulu rephrased UnsafeCell doc.
@csmoe informed user where to give a type annotation.
@frewsxcv unified ‘Platform-specific behavior’ documentation headings, fixed broken documentation link and removed section about compiler-rt in COPYRIGHT.
@QuietMisdreavus moved manual “extern crate” statements outside automatic “fn main”s in doctests in rustdoc and added readme for librustdoc.
@alercah added a warning to File about mutability.
@matthiaskrgr fixed more typos found by codespell.
@FraGag improved documentation of Clone and Copy implementors.
@zilbuz showed the used type variable when issuing a “can’t use type parameters from outer function” error message.
@GuillaumeGomez removed hoedown from rustdoc and added doc test command.

Recent doc contributions

@antoyo greatly improved primitive docs.
@estebank added -Zteach documentation.
@PramodBisht changed color of struct link from #ff794d to #2dbfb8 for Rust docs.
@matthiaskrgr fixed typo endianess to endianness (this also changes function names!).
@SergioBenitez clarified contiguity of Vec’s elements.
@dns2utf8 added link to yield_now.
@QuietMisdreavus added unit tests for rustdoc’s processing of doctests.
@jacob-hughes clarified why Sized bound not implicit on trait’s implicit Self type.
@Aaronepower updated RELEASES.md for 1.24.0.
@GuillaumeGomez showed better warning for trying to cast non-u8 scalar to char, rollup of 8 pull requests and fix condvar example.

Meetings

Next meeting will be on Tuesday 20th of February 2018 at 19:00 UTC on #rust-docs channel on irc.mozilla.org. Feel free to come!

Written on February 18, 2018