This Week in Rust Docs 34

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

Since new rustc version is out, the controversial changes on docs have been merged:

Don’t hesitate to give your feedbacks on them!

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!

Call for participation

There’s now a call for participation to display all methods of a type, even those from implicit traits in rustdoc. This is a great way to help users find everything that a type can do. Any help on it would be very appreciated!

Waiting for merge

@matklad advertised Vec in LinkedList docs.
@birkenfeld updated docs of slice get() and friends.
@KiChjang displayed better error messages for E0282.
@liigo made a minor fix about visibility in reference.
@estebank escaped the deprecated and unstable reason text in rustdoc, pointed out the known type when field doesn’t satisfy bound, provided disambiguated syntax for candidates in E0034 and showed span for trait that doesn’t implement Copy.
@federicomenaquintero documented the optional extra arguments to assert_eq!() / assert_ne!().
@durka fixed doctests with non-feature crate attrs in rustdoc.
@ollie27 removed broken src links from reexported items from macros in rustdoc.
@frewsxcv improved BTreeSet documentation and implemented fmt::Debug for all structures in libstd.
@rkruppe used abort() over loop {} for panic in the Book.
@Cobrand improved and fixed mpsc documentation.
@sourcefrog explained meaning of Result iters and link to factory functions and avoided using locally installed Source Code Pro font (fixes #24355)..
@michael-zapata harmonised rustdoc error messages.
@wezm simplified notes on testing and concurrency.
@GuillaumeGomez improved unix socket doc, added cast suggestions, fix invalid module suggestion, added more examples to UpdSocket and added ref suggestion.

Recent doc contributions

@estebank showed Trait instead of <Struct as Trait> in E0323.
@jonathandturner pointed arg num mismatch errors back to their definition.
@ollie27 added sort lines in search index and implementors js in rustdoc.
@Cobrand updated book/ffi to use catch_unwind.
@frewsxcv added docs for last undocumented Default impl..
@durka fixed reference definition of :tt.
@cardoe fixed: small typo in bootstrap/README.
@tarka made a minor fix to testing concurrency section.
@GuillaumeGomez fixed small typo, added missing examples for panicking objects, added checkup for return statement outside of a function, added examples for exit function, add missing links to Rc doc, added missing examples for Ipv6Addr, added part of missing UdpSocket’s urls and examples, added missing examples for IpAddr enum, added cloned example for Option and added Component examples.

Meetings

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

Written on December 11, 2016