This Week in Rust Docs 92
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 roadmap for 2018 is still in discussion. More information soon!
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
- @estebank added
-Zteach
documentation, reworded E0044 and message for!Send
types and detected possibly non-Rust closure syntax during parse. - @partim improved documentation for Borrow, AsRef, and friends.
- @dbrgn whitelisted based suggestions.
- @vi added foldable impl blocks in rustdoc.
- @wesleywiser fixed how paths are printed by error messages during bootstrap.
- @Aaron1011 generated documentation for auto-trait impls.
- @PramodBisht changed color of struct link from #ff794d to #2dbfb8 for Rust docs.
- @matthiaskrgr fixed typo: endianess to endianness (this also changes function names!).
- @GuillaumeGomez showed better warning for trying to cast non-u8 scalar to char.
Recent doc contributions
- @estebank added filtering options to
rustc_on_unimplemented
. - @clarcharr documented std::os::raw.
- @QuietMisdreavus added documentation from doc(include) to analysis data.
- @steveklabnik updated rust book.
- @varkor documented the behaviour of infinite iterators on potentially-computable methods, created a directory for –out-dir if it does not already exist and warned when rustc output conflicts with existing directories.
- @Manishearth fixed rustdoc ICE on macros defined within functions and bailed early for linky things in intra-docs-links.
- @frewsxcv clarified shared file handler behavior of File::try_clone.
- @zackmdavis declined to lint technically-unnecessary parens in function or method arguments inside of nested macros, corrected unused field pattern suggestions and corrected E0619 span re method call receivers whose type must be known.
- @Aaronepower updated RELEASES.md for 1.24.0.
- @matthiaskrgr fixed typo: substract -> subtract, fixed typos in src/{bootstrap,ci,etc,lib{backtrace,core,fmt_macros}} and fixed typos in config.toml.example.
- @ollie27 hid
-> ()
in cross crate inlined Fn bounds. - @RalfJung warned about more ignored bounds in type aliases.
- @Badel2 documented that associated constants prevent a trait from being made into an object.
- @mbrubeck fixed info about generic impls in AsMut docs.
- @jaystrictor removed ‘the this’ in doc comments.
- @GuillaumeGomez added tests for themes, fixed themes rendering issues on mobile, fixed const evaluation ICE in rustdoc and hide theme button under menu in mobile mode and fix top margin issue ….
Meetings
Next meeting will be on Tuesday 13th of February 2018 at 19:00 UTC on #rust-docs channel on irc.mozilla.org. Feel free to come!
Written on February 11, 2018