This Week in Rust Docs 2
Posted on by This week in Rust Docs
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.
This week’s edition was edited by: GuillaumeGomez.
Latest news
Things are moving on: we talked about hosting crates’ documentation directly on an official doc website (the hostname hasn’t been decided yet). It has already been discussed a few times in the past but nothing came out. For now, we’re mostly trying to sort through all of the complexity. A lot of details must be taken in account and it is still at a very early stage of discussion but it started!
The pull request on the new rustc output is finally here (or almost)!
@jonathandturner and @peschkaj are working on a style guide in order to help developers to write better library documentations.
Besides this, @peschkaj investigated the current doc status of the 20 biggest crates (based on number of downloads on crates.io). Take a look at the report The State of Rust Docs.
Current opened issues
For now, here are the issues opened for Rust documentation:
They both need help to move forward so any contribution is very welcome!
Recent doc contributions
- @timothy-mcroy added E0434 and E0501 errors explanation.
- @birkenfeld improved E0269 and E0432 errors explanation and fixed std::thread docs. He also clarified std::fmt dollar syntax.
- @mrmiywj improved E0008 error explanation.
- @bwinterton improved BTreeSet::Insert doc.
- @durka worked on tuple/unit structs in the rustbook.
- @benaryorg clarified documentation of TcpStream::connect for multiple valid addresses.
- @fitzgen clarified Iterator::enumerate doc example.
- @GuillaumeGomez’s Pull Request to add the
--extend-cssoption to rustdoc has been merged. He also worked on process types documentation.
Besides all this, a lot of improvements have been made to rustdoc source code:
- Linkify extern crates
- Improve accessibility of rustdoc pages
- Handle concurrent mkdir requests
- Only record the same impl once
- Inline all the impls
Meetings
Next meeting will be on Wednesday 4th of May 2016 at 20:00 GMT on #rust-docs channel on irc.mozilla.org, feel free to come!