This Week in Rust Docs 85

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 switch to Pulldown for the rust doc rendering has finally started!

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, showed closure signature on type errors and resolved type on return type suggestion.
@canndrew added docs for never primitive.
@zackmdavis added type error method suggestions use whitelisted identity-like conversions and added one-time diagnostics for private enum variants glob reexport.
@SimonSapin documented the size of bool.
@Aaronepower updated RELEASES.md for 1.23.0.
@partim improved documentation for Borrow, AsRef, and friends.
@QuietMisdreavus turned errors from loading external docs into a proper lint.
@GuillaumeGomez removed display of hidden types in rustdoc and stabilized allow_fail flag test feature.

Recent doc contributions

@estebank displayed \t in diagnostics code as four spaces.
@JRegimbal changed “Types/modules” title of search tab to be more accurate.
@tbu- clarified what -D warnings or -F warnings does.
@nak3 fixed invalid docs path for compiler plugins and fixed invalid link to lint_plugin_test.rs.
@tromey fixed documentation for DecodeUtf16Error.
@steveklabnik mentionned the name of ? in Result’s docs.
@vramana fixed bad error message for cannot_reborrow_already_uniquely_borrowed.
@ollie27 included impl [u8] in the docs.
@liigo specified that macro cfg! evaluating at compile-time.
@AgustinCB modified message for keyword as identifier name.
@notriddle renamed C-like enum to Field-less enum.
@frewsxcv documented behavior of ptr::swap with overlapping regions of memory.
@Havvy added compile_error macro examples.
@timotree3 updated old link.
@GuillaumeGomez added warnings for markdown doc generation, speedup search loading when search url is received in rust docs, fixed deduplication of items in rust docs search, fixed search results overlap, moved colors to main.css, fixed switched types in type mismatch error, fixed doc important trait display on mobile, greatly improved sidebar when width < 700px and improved search style.

Meetings

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

Written on December 10, 2017