This Week in Rust Docs 54

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, cleaned up callable type mismatch errors, made unsatisfied trait bounds note multiline and used diagnostics for trace_macro instead of println.
@irfanhudda improved documentation of next_power_of_two.
@icefoxen made a tiny update to rustdoc CSS.
@topecongiro updated docs of ‘fence’.
@abonander documented the proc_macro feature in the Unstable Book.
@ranma42 generate XZ-compressed tarballs.
@alexeyzab fixed error message for mismatched types.
@mandeep added generic example of std::ops::Add in doc comments.
@brson updated release notes for 1.17.
@steveklabnik improved [docs on Arc and Send/Sync](https://github.com/rust-lang/rust/pull/41536) and added [more ways to create a PathBuf to docs](https://github.com/rust-lang/rust/pull/41531).
@z1mvader rewrote the thread struct docs.
@GuillaumeGomez removed jquery dependency, reduced HTML output in rustdoc and added better error message when == operator is badly used.

Recent doc contributions

@estebank removes display of :: on tuple struct diagnostics and pointed at variable moved by closure.
@tbu- specified behavior of write_all for ErrorKind::Interrupted errors and fixed a copy-paste error in Instant::sub_duration.
@projektir added links and examples for various mspc pages.
@hsivonen explained why zero-length slices require a non-null pointer.
@frewsxcv bumped mdbook dep to pick up new ‘create missing’ toggle feature..
@moosingin3space explained process::exit in mem::forget docs.
@cuviper fixed links in RELEASES.md for 1.10.0 through 1.12.0.
@steveklabnik cleaned up TcpStream example, addressed platform-specific behavior in TcpStream::shutdown, fixed up vec guarantee around capacity, clarified “side effect” in peek’s docs, clarified the doc index and used the word ‘length’ in Vec::len’s docs.
@GuillaumeGomez added more explanation on RefCell::get_mut and improved error message for invalid module location.

Meetings

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

Written on April 30, 2017