This Week in Rust Docs 55

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, made unsatisfied trait bounds note multiline, used diagnostics for trace_macro instead of println and removed duplicated errors for closure type mismatch.
@irfanhudda improved documentation of next_power_of_two.
@icefoxen made a tiny update to rustdoc CSS.
@abonander documented the proc_macro feature in the Unstable Book.
@mandeep added generic example of std::ops::Add in doc comments.
@brson updated release notes for 1.17.
@steveklabnik improved docs on Arc<T> and Send/Sync and added more ways to create a PathBuf to docs.
@Mark-Simulacrum allowed # to appear in rustdoc code output. and made a minor cleanup of UX guidelines..
@Idolf supported #![deny(missing_docs)] together with #[proc_macro_derive].
@GuillaumeGomez reduced HTML output in rustdoc, added better error message when == operator is badly used, added help message if a FnOnce is moved and made –extend-css stable.

Recent doc contributions

@estebank cleaned up callable type mismatch errors.
@topecongiro updated docs of ‘fence’.
@alexeyzab fixed error message for mismatched types.
@z1mvader rewrote the thread struct docs.
@frewsxcv added links between slice::{copy,clone}_from_slice in docs, fixed incorrect hex value in doc comment example, simplified types in std::option doc comment example and made improvements to std::time::Duration doc examples.
@acdenisSK fixed “an” usage.
@rap2hpoutre added an example to std::thread::Result type.
@mgattozzi updated ChildStdin/ChildStdout docs to be clearer.
@bholley documented the reasoning for the Acquire/Release handshake when dropping Arcs.
@cuviper fixed links in RELEASES.md for 1.10.0 through 1.12.0.
@Mark-Simulacrum removed ANTLR grammar and unignored tests which work fine now.
@oli-obk minimized single span suggestions into a label.
@hsivonen explained why zero-length slices require a non-null pointer.
@GuillaumeGomez removed jquery dependency and add option to display warnings in rustdoc.

Meetings

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

Written on May 7, 2017