This Week in Rust Docs 91

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

This week was a big one: the whole new url system and the multiple themes support have been added in rustdoc!

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 added filtering options to rustc_on_unimplemented and added -Zteach documentation.
@partim improved documentation for Borrow, AsRef, and friends.
@clarcharr documented std::os::raw.
@dbrgn whitelisted based suggestions.
@vramana improved error messages in the case of partial and collateral moves for NLL and improved move related error messages.
@QuietMisdreavus added documentation from doc(include) to analysis data.
@steveklabnik updated rust book.
@varkor documented the behaviour of infinite iterators on potentially-computable methods.
@Manishearth fixed rustdoc ICE on macros defined within functions.
@frewsxcv clarified shared file handler behavior of File::try_clone.
@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.
@zackmdavis declined to lint technically-unnecessary parens in function or method arguments inside of nested macros and corrected unused field pattern suggestions.
@PramodBisht changed color of struct link from #ff794d to #2dbfb8 for Rust docs.
@GuillaumeGomez added tests for themes, fixed themes rendering issues on mobile and fixed const evaluation ICE in rustdoc.

Recent doc contributions

@estebank highlighted code on diagnostics when underlined, included space in suggestion mut in bindings, tweaked presentation on lifetime trait mismatch, minimized weird spans involving macro context and suggested removing value from break when invalid.
@SimonSapin documented the size of bool.
@varkor added line numbers and columns to error messages spanning multiple files.
@jimmantooth improved punctuation and clarity.
@vmx fixed lang items box example code.
@etaoins improved char escaping in lexer messages, fixed ICE on const eval of union field and avoided underflow in render_source_line.
@euclio used correct casing for rename suggestions.
@frewsxcv documented that Index ops can panic on HashMap & BTreeMap.
@ollie27 fixed link title rendering with hoedown in rustdoc.
@GuillaumeGomez fixed ugly hover in sidebar and updated associated constants error message.

Meetings

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

Written on February 4, 2018