This Week in Rust Docs 35

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 improved the API examples for std::fs::File, documented platform-specific differences for std::process::exit, improved documentation for core::hash::BuildHasherDefault and improved BTreeSet documentation.
@bluecereal updated if-let.md.
@brson wrote the 1.14 release notes.
@ollie27 fixed invalid HTML in stability notices in rustdoc and fixed short summaries in search results in rustdoc.
@estebank used struct name as span instead of entire block, disambiguated Implementors when the type name is not unique in rustdoc, showed span for trait that doesn’t implement Copy, escaped the deprecated and unstable reason text in rustdoc, pointed out the known type when field doesn’t satisfy bound and provided disambiguated syntax for candidates in E0034.
@matklad advertised Vec in LinkedList docs.
@birkenfeld updated docs of slice get() and friends.
@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.
@federicomenaquintero documented the optional extra arguments to assert_eq!() / assert_ne!().
@rkruppe used abort() over loop {} for panic in The Book.
@GuillaumeGomez improved thread docs, improved unix socket doc, improved duration doc and improved instant doc.

Recent doc contributions

@KiChjang displayed better error messages for E0282.
@ollie27 removed broken src links from reexported items from macros in rustdoc.
@Cobrand improved and fixed mpsc documentation.
@sourcefrog avoided using locally installed Source Code Pro font in rustdoc.
@michael-zapata harmonised rustdoc error messages.
@brson updated The Book for rustup.
@GuillaumeGomez added more examples to UpdSocket.

Meetings

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

Written on December 18, 2016