This Week in Rust Docs 31

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

@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..
@jfirebaugh added a distinct error code and description for “main function has wrong type”.
@GuillaumeGomez removed unneeded tricky macro doc, added missing examples for Ipv6Addr, added missing examples in SocketAddr, added information in case of markdown block code test failure and added ref suggestion.

Recent doc contributions

@keeperofdakeys improved the #[should_panic] feature and show a better error when using –test with #[proc_macro_derive].
@jedireza fixed grammar typos in ffi.md.
@dns2utf8 added grammar verification build command.
@liigo added cli argument --playground-url in rustdoc.
@tshepang fixed nits and typos on comments in doc.
@robinst added semicolon to “perhaps add a use for one of them” help.
@tarka added sections about testing concurrency and stdout/err capture.
@ollie27 fixed some local inlining issues in rustdoc.
@frewsxcv updated top-level path doc examples to show results. and rewrote std::path::Path::push doc example..
@euclio removed deprecated text for unstable docs.
@polo-language improved punctuation, capitalization, and sentence structure of code snippet comments.
@QuietMisdreavus folded fields for enum struct variants into a docblock in rustdoc.
@GuillaumeGomez improved reference cast help message, added net examples and uncommented some long error explanation.

Meetings

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

Written on November 20, 2016