This Week in Rust Docs 63
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
None.
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.
- @Fourchaux fixed basic typos in Doc Comments.
- @dns2utf8 added hint about the return code of panic!.
- @Emilgardis fixed wrong report on closure args mismatch when a ref is expected but not found.
- @Mark-Simulacrum refactored pretty printing slightly and allowed setting the limit on std::io::Take.
- @GuillaumeGomez added warnings when rustdoc html rendering differs, added errors when doc comments are added where they’re unused, cleaned up some code and add spacing between trait functions.
Recent doc contributions
- @rthomas updated docs for Debug* structs and added annotations to the resize fn.
- @cengizIO added pager support for
rustc --explain EXXXX
. - @Boreeas folded E0612, E0613 into E0609.
- @estebank added
rustc_on_unimplemented
message tostd::ops::Try
and made suggestion include the line number. - @durka fixed links for typeck diagnostics without tripping tidy.
- @arielb1 reported the total number of errors on compilation failure.
- @ollie27 fixed markdown tests being run twice.
- @stjepang made a minor fix in docs for Vec.
- @andersk documented unintuitive argument order for Vec::dedup_by relation.
- @GuillaumeGomez fixed toggle wrappers not generated correctly in rustdoc.
Meetings
Next meeting will be on Wednesday 12th of July 2017 at 20:00 GMT on #rust-docs channel on irc.mozilla.org. Feel free to come!
Written on July 9, 2017