This Week in Rust Docs 89

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

The hoedown -> pulldown migration moved forward by a step this last week: now the default renderer is pulldown.

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 highlighted code on diagnostics when underlined, suggested casting on numeric type error, added a custom error when moving arg outside of its closure, added filtering options to rustc_on_unimplemented, added env flags RUSTC_COLOR and RUSTC_ERROR_FORMAT, removed private traits suggestions on missing method and included space in suggestion mut in bindings.
@SimonSapin documented the size of bool.
@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.
@est31 checked for deadlinks from the summary during book generation.
@Manishearth implemented RFC 1946 - intra-rustdoc links.
@Aaronepower updated RELEASES.md for 1.24.0.
@sdroege fixed broken links to other slice functions in chunks/chunks_mut/exact_….
@PieterPenninckx made small improvements to the documentation of VecDeque.
@astraw fixed doctests for BTreeSet to use BTreeSet (not BTreeMap).
@QuietMisdreavus added documentation from doc(include) to analysis data.
@GuillaumeGomez added multiple themes support in rustdoc and added E0659 for ambiguous names.

Recent doc contributions

@hellow554 added kbd style tag to main.css in rustdoc.
@davidtwco fixed bad error message when converting anonymous lifetime to 'static for NLL.
@tspiteri showed that f32::log and f64::log are not correctly rounded in docs.
@Manishearth fixed line offsets for doctests.
@carols10cents standardized on “re-export” rather than “reexport”.
@arthurprs updated BTreeMap recommendation.
@estebank removed suggestion to make mut binding external to Fn closure, pointed at method with the requirements on E0283 and pointed at unused arguments for format string.
@tbu- added some edge cases to the documentation of Path.
@goffrie removed incorrect Default::default links, add a new one.
@gaurikholkar fixed mispositioned span in suggestions with wide characters.
@GuillaumeGomez added error code for unstable feature errors, added tests for rustdoc search, switched to pulldown as default markdown renderer and updated html-diff crate (fix unicode parsing and invalid paths).

Meetings

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

Written on January 21, 2018