This Week in Rust Docs 94

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, suggested setting associated type when type argument is given instead and provided context for missing comma in match arm and if statement without block.
@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.
@NovemberZulu rephrased UnsafeCell doc.
@QuietMisdreavus added readme for librustdoc.
@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.
@remexre fixed docs for ASCII functions to no longer claim U+0021 is ‘@’.
@christianpoveda made new Cell docs.
@mark-i-m splitted E0404 to E0909; get rid of E0245 and started moving to the rustc guide!.
@frewsxcv clarified “It is an error to…” wording for zero-duration behaviors.
@Phlosioneer made slight modification to the as_ref example of std::option::Option.
@Centril documented panics in Clone, PartialEq, PartialOrd, Ord for RefCell.
@flip1995 suggested type for overflowing bin/hex-literals.
@jethrogb clarified interfaction between File::set_len and file cursor.
@lukaslueg fixed spelling s/casted/cast/.
@RalfJung warned about ignored generic bounds in for.
@Aaronepower updated RELEASES.md for 1.25.0.
@GuillaumeGomez added back rustc explain, added resource-suffix option for rustdoc, add root-path, added error codes for libsyntax_ext, added new warning for CStr::from_ptr, added rustdoc theme securities and fixed auto trait impl rustdoc ice.

Recent doc contributions

@estebank avoided ICE in arg mistmatch error for tuple variants and handled custom diagnostic for &str + String.
@Aaron1011 generated documentation for auto-trait impls.
@topecongiro fixed span of visibility.
@csmoe informed user where to give a type annotation.
@frewsxcv unified ‘Platform-specific behavior’ documentation headings, fixed broken documentation link and marked doc examples w/ extern blocks as ignore.
@QuietMisdreavus moved manual “extern crate” statements outside automatic “fn main”s in doctests in rustdoc and fixed crash when an external trait’s docs needs to import another trait in rustdoc.
@alercah added a warning to File about mutability.
@matthiaskrgr fixed more typos found by codespell.
@varkor introduce UnpackedKind.
@Manishearth implemented implied shortcut links for intra-rustdoc-links.
@dwijnand fixed capitalisation in Path#file_name’s docs.
@steveklabnik updated the book to promote second edition.
@withoutboats added nonstandard_style alias for bad_style.
@mbrubeck made minor wording changes to drain_filter docs.
@adeschamps made a small grammar fix to docs for String::new().
@ordovicia take 2^5 as examples in document of pow().
@redcape fixed count usize link typo in docs.
@m0ppers added missing link for read_line.
@GuillaumeGomez removed hoedown from rustdoc, added doc test command and fixed rustdoc test ICE.

Meetings

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

Written on February 25, 2018