This Week in Rust Docs 32

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

@alygin fixed error explanation formatting.
@liigo got back missing crate-name when –playground-url is used in rustdoc and added suggestions “#[macro_use]” for all undefined macros.
@sourcefrog documented that Process::command will search the PATH and made a clearer description of std::path::MAIN_SEPARATOR.
@Cobrand improved and fixed mpsc documentation.
@wezm simplified notes on testing and concurrency.
@mikhail-m1 added hint to fix error for immutable ref in arg.
@sanxiyn warned unused type parameters and warned unused type aliases.
@estebank showed multiline spans in full if short enough and detected missing ; on methods with return type ().
@steveklabnik replaced rustup.sh with rustup.rs in The Book.
@GuillaumeGomez added examples for TcpListener struct, added part of missing UdpSocket’s urls and examples, added information in case of markdown block code test failure, added checkup for return statement outside of a function, added missing examples for Ipv6Addr, started of implementation of proposal for E0308, added ref suggestion and removed unneeded tricky macro doc.

Recent doc contributions

@eddyb separated test collection from the main “clean”-ing pipeline in rustdoc.
@estebank provided hint when cast needs a dereference.
@birkenfeld fixed duplicate bullet points in feature list.
@brcooley fixed grammar error in lifetimes.md.
@ojsheikh updated E0088 to new error format.
@steveklabnik clarified the reference’s status..
@sfackler fixed two small issues in iterator docs.
@vickenty followed our own recommendations in the examples.
@frewsxcv documented how lock ‘guard’ structures are created..
@fkjogu defined bound argument in std::sync::mpsc::sync_channel in the documentation.
@samestep replaced “radicum” with “radices”.
@GuillaumeGomez added missing examples in SocketAddr, added missing urls and examples to TcpStream and added missing examples to SocketAddrV6.

Meetings

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

Written on November 27, 2016