This Week in Rust Docs 98

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

@FraGag improved documentation of Clone and Copy implementors.
@tinaun removed erroneous error message when checking impl trait params.
@gaurikholkar modified E0389 error message.
@QuietMisdreavus suppressed the default allow(unused) under –display-warnings in rustdoctest and moved the “important traits” button to beside the type in rustdoc.
@Phlosioneer documented when types have OS-dependent sizes.
@klnusbaum provided better borrow checker error message.
@pthariensflame made a minor message/label formatting consistency fix.
@krk added submodule fetch instructions.
@chisophugis fixed confusing doc for scan.
@sinkuu added support for universal_impl_trait in rustdoc.
@PramodBisht fixed doc comments present after a particular syntax error cause an unhelpful error message to be output.
@zackmdavis added suggestion of ! for erroneous identifier not and pointed to value in “value assigned is never read” lint.
@GuillaumeGomez added error codes for libsyntax_ext, fixed impl assoc constant link not working, removed unneeded trait implementations titles, added repeat method on slice and proposed a variant if it is an enum for E0599.

Recent doc contributions

@partim improved documentation for Borrow, AsRef, and friends.
@QuietMisdreavus exposed #[target_feature] attributes as doc(cfg) flags in rustdoc, added an “unstable features” chapter to the rustdoc book and whitelisted every target feature for rustdoc.
@csmoe improved error message of inner attribute syntax.
@SimonSapin added an example of lossy decoding to str::Utf8Error docs and fixed incorrect copy-paste for new X? in formatting strings.
@ysiraichi suggested removing &s.
@RalfJung improved lint for type alias bounds.
@klnusbaum renamed epoch to edition.
@steveklabnik updated books for next release.
@ordovicia improved diagnostics for ‘..’ pattern fragment not in the last position.
@Centril documented format_args! / Arguments<’a> behavior wrt. Display and Debug.
@davidtwco hosted compiler documentation.
@sanxiyn documented only-X test header.
@estebank reduced the diagnostic spam when multiple fields are missing in pattern.
@Aaronepower updated RELEASES.md for 1.25.0.
@GuillaumeGomez added warning for invalid start of code blocks in rustdoc, and made Atomic doc examples specific to each type, fixed IE11 search, fixed automatic urls with backticks and fixed events handling in rustdoc.

Meetings

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

Written on March 25, 2018