This Week in Rust Docs 90
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
This week was a big one: the whole new url system and the multiple themes support have been added in rustdoc!
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, added filtering options to
rustc_on_unimplemented
, added env flagsRUSTC_COLOR
andRUSTC_ERROR_FORMAT
, included space in suggestionmut
in bindings, tweaked error message when reborrowing&mut self
asmut
and tweaked presentation on lifetime trait mismatch. - @SimonSapin documented the size of bool.
- @partim improved documentation for Borrow, AsRef, and friends.
- @clarcharr documented std::os::raw and move Duration to libcore.
- @dbrgn whitelisted based suggestions.
- @vramana improved error messages in the case of partial and collateral moves for NLL and improved move related error messages.
- @Aaronepower updated RELEASES.md for 1.24.0.
- @QuietMisdreavus added documentation from doc(include) to analysis data.
- @steveklabnik updated rust book.
- @varkor added line numbers and columns to error messages spanning multiple files and documented the behaviour of infinite iterators on potentially-computable methods.
- @jimmantooth improved punctuation and clarity.
- @GuillaumeGomez added tests for themes and fixed themes rendering issues on mobile.
Recent doc contributions
- @estebank suggested casting on numeric type error, added a custom error when moving arg outside of its closure, removed private traits suggestions on missing method, correctly formatted
extern crate
conflict resolution help, pointed at the “head” expression for E0277 onfor
loops, point and pointed at unknown lang item attribute. - @est31 checked for deadlinks from the summary during book generation.
- @Manishearth implemented RFC 1946 - intra-rustdoc links and fixed intra-doc-links.
- @sdroege fixed broken links to other slice functions in chunks/chunks_mut/exact_….
- @PieterPenninckx made small improvements to the documentation of VecDeque.
- @astraw fixed doctests for BTreeSet to use BTreeSet (not BTreeMap).
- @ollie27 removed methods from #[doc(masked)] crates from the search index in rustdoc and showed when traits are auto traits in rustdoc.
- @evelynmitchell fixed invalid URL.
- @GuillaumeGomez added multiple themes support in rustdoc, added E0659 for ambiguous names, fixed experimental text display on default theme, made a few fixes for multiple themes support feature and fixed quoted search.
Meetings
Next meeting will be on Tuesday 30th of January 2018 at 19:00 UTC on #rust-docs channel on irc.mozilla.org. Feel free to come!