This Week in Rust Docs 53

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

After a long debate, it has been decided to keep hoedown testing/rendering by default in rustdoc. However, you can test pulldown by running rustdoc with -Z unstable-options enable-commonmark.

The jquery dependency is being removed from the rustdoc javascript. When navigating in the docs, please check if everything’s working as expected!

Current opened issues

For now, here are the two 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 pointed at fields that make the type recursive, emitted diagnostic when using const storing Fn as pattern and did not show :: on tuple struct diagnostics.
@irfanhudda improved documentation of next_power_of_two.
@stepancheg improved BufRead::is_eof documentation.
@icefoxen made a tiny update to rustdoc CSS.
@topecongiro updated docs of ‘fence’.
@abonander documented the proc_macro feature in the Unstable Book.
@tbu- specified behavior of write_all for ErrorKind::Interrupted errors.
@projektir added links and examples for various mspc pages.
@insaneinside removed display of duplicate bounds for “…but the following trait bounds were not satisfied”.
@GuillaumeGomez added more explanation on RefCell::get_mut, removed jquery dependency and reduced HTML output in rustdoc.

Recent doc contributions

@estebank reduced visual clutter of multiline start when possible and added a way to get shorter spans until char for pointing at defs.
@maccoda improved Convert docs.
@mgattozzi updated Child docs to not have a note section.
@frewsxcv added top level sections to the Unstable Book..
@cengizIO moved E0101 and E0102 logic into new E0282 mechanism.
@jonhoo renamed compiler_barrier to compiler_fence.
@QuietMisdreavus added a list of headings to the sidebar in rustdoc.
@alexeyzab fixed old docs.
@mbrubeck expanded docs and examples for PathBuf::file_name and friends.
@lukaramu improved std::path docs.
@steveklabnik fixed link to book repo and updated mdbook.
@durka removed disclaimer from bootstrap/README.md.
@mbrickn updated links to use https.
@GuillaumeGomez added ref suggestion, made hoedown big comeback, fixed debug infinite loop, fixed line display for hoedown and re-enabled hoedown by default.

Meetings

Next meeting will be on Wednesday 26th of April 2017 at 20:00 GMT on #rust-docs channel on irc.mozilla.org. Feel free to come!

Written on April 23, 2017