This Week in Rust Docs 36

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 way rustdoc is creating urls is problematic for the moment. A good summary of this issue can be found here. A few members of the Rust Doc team are preparing an RFC in order to improve this. If you want to get involved, feel free to speak about it with Guillaume Gomez (imperio on IRC).

Please take a look to the next rust doc days planning reminder.

The topic to propose crates for the Rust Doc Days is still open and waiting for contributions here. Please take a look!

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 A-docs tagged issues on GitHub!

Waiting for merge

@frewsxcv clarified behavior of VecDeque::insert, clarified phrasing of MSYS2 dependencies in README.md, made improvements to ‘include’ macro documentation and clarified zero-value behavior of ctlz/cttz intrinsics.
@GuillaumeGomez improved builder docs, added missing urls in Arc docs, added missing example for Thread struct, added ref suggestion, improved instant doc, added information in case of markdown block code test failure and fixed invalid module suggestion.
@estebank escaped the deprecated and unstable reason text in rustdoc.
@nagisa expanded documentation of process::exit and exec.
@rkruppe used abort() over loop {} for panic in The Book.
@chris-morgan fixed rustdoc highlighting of & and *.
@ollie27 fixed invalid HTML in stability notices in rustdoc.
@linclark added error explanation for E0328..
@chriskrycho documented RFC 1623: static lifetime elision..
@federicomenaquintero documented the optional extra arguments to assert_eq!() / assert_ne!().

Recent doc contributions

@frewsxcv improved the API examples for std::fs::File, documented platform-specific differences for std::process::exit, improved documentation for core::hash::BuildHasherDefault, improved BTreeSet documentation and implement fmt::Debug for all structures in libstd..
@brson wrote the 1.14 release notes.
@ollie27 fixed short summaries in search results in rustdoc.
@estebank pointed out the known type when field doesn’t satisfy bound and explained why/when .lines() returns an error.
@matklad advertised Vec in LinkedList docs.
@sourcefrog explained the meaning of Result iters and link to factory functions.
@tshepang fixed a formatting nit in rustdoc.
@wezm simplified notes on testing and concurrency.
@jonhoo expanded E0309 explanation with motivating example.
@GuillaumeGomez improved thread docs, improved unix socket doc, improved duration doc, added JoinHandle missing examples, added missing examples in some thread functions and added cast suggestions.
@DirkyJerky created hyperlink to correct documentation.
@QuietMisdreavus properly calculated line length for where clauses.
@clarcharr removed @import normalize.css.
@stjepang made a minor fix in the merge_sort comments.

Meetings

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

Written on December 25, 2016