This Week in Rust Docs 79
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
The switch to Pulldown for the rust doc rendering has finally started!
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
- @QuietMisdreavus included external files in documentation in rustdoc (RFC 1990) and showed in docs whether the return type of a function impls Iterator/Read/Write.
- @joshleeb fixed duplicated display of error E0502.
- @Aaronepower updated Release notes for 1.22.0.
- @leodasvacas documented that call expressions also represent ADT constructors.
- @estebank detected
=
->:
typo in let bindings. - @GuillaumeGomez improved sidebar rendering and added methods list, added missing links and examples, add missing docs for MetadataExt and fixed title heading overlap in rust doc.
Recent doc contributions
- @QuietMisdreavus updated pulldown and fixed spurious rendering difference around footnotes.
- @frewsxcv improved docs around
Once::call_once_force
andOnceState
, removed ‘future Rust version’ code block in diagnostic text and improved docs for UdpSocket::set_nonblocking. - @carols10cents corrected misspelling in error text: re-assignment => reassignment, updated the book for a fix to the print button and updated the book on beta to fix the print button.
- @Technius improved std::process module docs.
- @nzig fixed rustc_on_unimplemented example in Unstable Book.
- @steveklabnik removed ‘just’ in diagnostics and fixed formatting in unstable book’s attr-literals section.
- @thombles improved diagnostics when list of tokens has incorrect separators.
- @michaelwoerister removed duplicated compiler diagnostic emissions.
- @GuillaumeGomez added short error message-format, limited the sidebar height, added missing code examples and showed src button and function version on mobile version.
Meetings
Next meeting will be on Tuesday 31st of October 2017 at 19:00 UTC on #rust-docs channel on irc.mozilla.org. Feel free to come!
Written on October 29, 2017