This Week in Rust Docs 99

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

We’re back from the all-hands week in Berlin. A lot of things are coming. More information soon?

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.
@QuietMisdreavus suppressed the default allow(unused) under –display-warnings in rustdoctest, moved the “important traits” button to beside the type in rustdoc and added an –edition flag to compile docs/doctests with a certain edition in rustdoc.
@klnusbaum provided better borrow checker error message.
@krk added submodule fetch instructions.
@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.
@SimonSapin soft-deprecated the description() method of the Error trait.
@frewsxcv clarified network byte order conversions for integer / IP address conversions.
@Phlosioneer added test for rustdoc ignore test and fixed escaped backslash in windows file not found message.
@Aaronepower updated RELEASES.md for 1.26.0.
@sgrif removed the “leak check” in favor of “universes”.
@ollie27 added docs for the test crate with the std docs.
@GuillaumeGomez added error codes for libsyntax_ext, removed unneeded trait implementations titles, added repeat method on slice, stabilized short error format, added page to list all crate’s items, added warning if a resolution failed, added support for variant and types fields for intra links, added missing anchor for union type fields, fixed targetted value background and fixed anchor position on fields.

Recent doc contributions

@Phlosioneer documented when types have OS-dependent sizes.
@pthariensflame made a minor message/label formatting consistency fix.
@chisophugis fixed confusing doc for scan.
@sinkuu added support for universal_impl_trait in rustdoc.
@cuviper corrected a typo in RELEASES.md.
@joshtriplett fixed documentation for size of Option<NonNull<T>>.
@frewsxcv explicitly mentionned Option in ? error message, clarified “length” wording in Vec::with_capacity and removed hidden foo functions from doc examples; use Termination trait.
@lukaslueg updated CONTRIBUTING.md.
@alercah added missing ‘?’ to format grammar.
@ehuss fixed diagnostic colors on Windows 10 console.
@GuillaumeGomez fixed impl assoc constant link not working, proposed a variant if it is an enum for E0599, added primitive intra-links, hid type declarations by default, renamed main theme into light theme, fixed tooltip position, fixed search appearance, fixed collapse toggle insertions on impl with docs, fixed trait implementation not collapsing docs and fixed text overlap.

Meetings

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

Written on April 1, 2018