This Week in Rust Docs 64
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
@steveklabnik ended the first version of the rewrite of rustdoc using RLS. It’s far from done but don’t hesitate to give it a try!
Current opened issues
For now, here are the three big issues for Rust documentation:
- The Standard Library Documentation Checklist
- Add error explanations for all error codes
- Document all features in the Rust reference
They all need help to move forward so any contribution is very welcome!
There are currently around 70 other documentation issues opened. Look for T-doc tagged issues on GitHub!
Waiting for merge
- @oli-obk changed some notes into suggestions.
- @Aaronepower updated releases notes for 1.19.
- @rthomas updated docs on Error struct.
- @Emilgardis fixed wrong report on closure args mismatch when a ref is expected but not found.
- @gaurikholkar reordered span suggestions to appear below main labels.
- @Others improved panic docs for Instant::duration_since.
- @RalfJung clarified wording for E0122.
- @GuillaumeGomez added warnings when rustdoc html rendering differs, added errors when doc comments are added where they’re unused, added TryFrom implementation for bool, f32 and f64 and added a message when a variable name collides with a function name.
Recent doc contributions
- @dns2utf8 added hint about the return code of panic!.
- @Mark-Simulacrum refactored pretty printing slightly and tested src/doc once more.
- @steveklabnik updated the books. and added the Code of Conduct to the repository.
- @kennytm fixed minor typo in std::path documentation..
- @Havvy documented what happens on failure in path ext is_file is_dir.
- @jgallag88 added warning to BufWriter documentation.
- @GuillaumeGomez cleaned up some code, added spacing between trait functions in rustdoc and added a failure in case nothing to run was found.
Meetings
Next meeting will be on Wednesday 19th of July 2017 at 20:00 GMT on #rust-docs channel on irc.mozilla.org. Feel free to come!