This Week in Rust Docs 87

Posted on January 07, 2018 by This week in Rust Docs

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

Happy new year! The last year has been very intense in the Rust documentation world:

We improved the documentation search (both display and search itself).
We improved the documentation display (it now fully works on mobile devices!).
We added more information into the documentation (the crate version, if the return type is implements any of Iterator/Read/Write trait, and a lot more…).
We added the possibility to include external files in documentation.
We (finally!) started the migration of our markdown renderer from hoedown to pulldown.
We added examples to every function/methods/types to allow readers to understand more quickly.
We added a lint (missing_docs) to allow you to never miss an item not being documented.
And a lot more of awesome changes!

Maybe a blog post will be wrote to sum all this up, we’ll see.

Now time to catch up the two missing weeks!

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, provided suggestion when trying to use method on numeric literal and added a custom error when moving arg outside of its closure.
@zackmdavis added type error method suggestions use whitelisted identity-like conversions and fixed the doc-comment-decoration-trimming edge-case rustdoc ICE.
@SimonSapin documented the size of bool.
@partim improved documentation for Borrow, AsRef, and friends.
@keatinge added help message for incorrect pattern syntax.
@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.
@ollie27 added missing src links for generic impls on trait pages in rustdoc.
@GuillaumeGomez stabilized allow_fail flag test feature.

Recent doc contributions

@Aaronepower updated RELEASES.md for 1.23.0.
@MaloJaffre added compiler docs testing to CI.
@tspiteri improved None condition doc for checked_div and checked_rem in docs.
@stjepang wrote examples for {BTree,Hash}Set::{get,replace,take}.
@kennytm added a tidy check for missing or too many trailing newlines.
@SergioBenitez clarified appending behavior of ‘io::Read::read_to_string()’.
@frewsxcv minor rewrite of env::current_exe docs; clarified symlinks and documented when LineWriter flushes; document errors for into_inner.
@ollie27 corrected a few stability attributes.
@dzamlo fixed an error in std::process documentation.
@varkor fixed doc typo for is_ascii_graphic.
@Sogomn defocused search bar in rustdoc pages.
@estebank reworded reason for move note and reworded trying to operate in immutable fields.
@mark-i-m fixed typo.
@fschutt improved error messages for linking failure.
@GuillaumeGomez removed display of hidden types in rustdoc, made doc search more relevant and fixed search bar defocus.

Meetings

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