This Week in Rust Docs 95

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

Nothing interesting enough.

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 and suggested setting associated type when type argument is given instead.
@partim improved documentation for Borrow, AsRef, and friends.
@NovemberZulu rephrased UnsafeCell doc.
@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.
@christianpoveda made new Cell docs.
@Phlosioneer made slight modification to the as_ref example of std::option::Option.
@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.
@scottmcm improved docs and associated SUCCESS/FAILURE for process::ExitCode and produced better size_hints from Flatten & FlatMap.
@tinaun removed erroneous error message when checking impl trait params.
@ehuss added crate name to “main function not found” error message.
@focusaurus remember state of top-level collapse toggle widget in rust docs.
@GuillaumeGomez added resource-suffix option for rustdoc, added error codes for libsyntax_ext, added new warning for CStr::from_ptr, updated rustc –explain sentence, put back ui json check and added warning for invalid start of code blocks in rustdoc.

Recent doc contributions

@estebank provided context for missing comma in match arm and if statement without block.
@vi added foldable impl blocks in rustdoc.
@QuietMisdreavus added readme for librustdoc.
@remexre fixed docs for ASCII functions to no longer claim U+0021 is ‘@’.
@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.
@Centril documented panics in Clone, PartialEq, PartialOrd, Ord for RefCell.
@steveklabnik removed production TOCs for doc markdown files.
@teiesti fixed link to rustc guide in README.md.
@pthariensflame made a minor grammatical/style fix in docs.
@GuillaumeGomez added back rustc explain, added rustdoc theme securities and fixed auto trait impl rustdoc ice.

Meetings

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

Written on March 4, 2018