This Week in Rust Docs 86
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
- @estebank highlighted code on diagnostics when underlined, showed closure signature on type errors and fixed incorrect type mismatch label pointing at return type.
- @zackmdavis added type error method suggestions use whitelisted identity-like conversions.
- @SimonSapin documented the size of bool.
- @Aaronepower updated RELEASES.md for 1.23.0.
- @partim improved documentation for Borrow, AsRef, and friends.
- @MaloJaffre added compiler docs testing to CI.
- @GuillaumeGomez removed display of hidden types in rustdoc, stabilized allow_fail flag test feature and made doc search more relevant.
Recent doc contributions
- @estebank resolved type on return type suggestion, pointed at var in short lived borrows instead of drop location and pointed at whole method call instead of args.
- @canndrew added docs for never primitive.
- @zackmdavis added one-time diagnostics for private enum variants glob reexport.
- @matthewjasper used a better link for method resolution in Deref docs.
- @tshepang made a better example in docs.
- @rillian marked ascii methods on primitive types stable in 1.23.0 not 1.21.0.
- @emilio fixed typo in infer README.
- @GuillaumeGomez fixed mobile doc style and improve search bar, fixed type filter in rustdoc js and fixed switched types in type mismatch.
Meetings
Next meeting will be on Tuesday 19th of December 2017 at 19:00 UTC on #rust-docs channel on irc.mozilla.org. Feel free to come!
Written on December 17, 2017