This Week in Rust Docs 88

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 and added a custom error when moving arg outside of its closure.
@SimonSapin documented the size of bool.
@partim improved documentation for Borrow, AsRef, and friends.
@clarcharr documented std::os::raw, better Debug impl for io::Error.
@hellow554 added kbd style tag to main.css in rustdoc.
@dbrgn whitelisted based suggestions.
@vramana improved error messages in the case of partial and collateral moves for NLL and improved move related error messages.
@etaoins extended macro name suggestion span.
@davidtwco fixed bad error message when converting anonymous lifetime to 'static for NLL.
@est31 checked for deadlinks from the summary during book generation.
@tspiteri showed that f32::log and f64::log are not correctly rounded in docs.
@Manishearth fixed line offsets for doctests and implemented RFC 1946 - intra-rustdoc links.
@carols10cents standardized on “re-export” rather than “reexport”.
@ollie27 populated external_traits with traits only seen in impls in rustdoc.
@Aaronepower updated RELEASES.md for 1.24.0.
@GuillaumeGomez stabilized allow_fail flag test feature, added error code for unstable feature errors, test rustdoc js and switched to pulldown as default markdown renderer.

Recent doc contributions

@estebank provided suggestion when trying to use method on numeric literal.
@zackmdavis added type error method suggestions use whitelisted identity-like conversions and fixed the doc-comment-decoration-trimming edge-case rustdoc ICE.
@keatinge added help message for incorrect pattern syntax.
@ollie27 added missing src links for generic impls on trait pages in rustdoc.
@whentze fixed docs for OsStr.
@overvenus fixed examples of Duration::subsec_millis and Duration::subsec_micros.
@alercah fixed typo.

Meetings

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

Written on January 14, 2018