This Week in Rust Docs 30
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
Since new rustc version is out, the controversial changes on docs have been merged:
- Fold fields for enum struct variants into a docblock in rustdoc
- Add line breaks to where clauses a la rustfmt in rustdoc.
- Print more tags in rustdoc.
Don’t hesitate to give your feedbacks on them!
The way rustdoc is creating urls is problematic for the moment. A good summary of this issue can be found here. A few members of the Rust Doc team are preparing an RFC in order to improve this. If you want to get involved, feel free to speak about it with Guillaume Gomez (imperio on IRC).
Please take a look to the next rust doc days planning reminder.
The topic to propose crates for the Rust Doc Days is still open and waiting for contributions here. Please take a look!
Current opened issues
For now, here are the three big issues for Rust documentation:
- Error code list which need to be updated to new format
- The Standard Library Documentation Checklist
- Add error explanations for all error codes
They all need help to move forward so any contribution is very welcome!
There are currently around 70 other documentation issues opened. Look for A-docs tagged issues on GitHub!
Call for participation
There’s now a call for participation to display all methods of a type, even those from implicit traits in rustdoc. This is a great way to help users find everything that a type can do. Any help on it would be very appreciated!
Waiting for merge
- @estebank added the detection for missing
;on methods with return type(), provided hint when cast needs a dereference, added multiline spans in full if short enough, disallowed ‘start’ feature on nested function in E0526 and added the detection for double reference when applying binary op. - @keeperofdakeys improved the #[should_panic] feature.
- @jedireza fixed grammar typos in ffi.md.
- @brson removed all “consider using an explicit lifetime parameter” suggestions.
- @jfirebaugh removed long diagnostic for E0002 and added a distinct error code and description for “main function has wrong type”.
- @dns2utf8 added grammar verification build command.
- @GuillaumeGomez added ref suggestion, improved reference cast help message, added information in case of markdown block code test failure and started implementation of proposal for E0308.
Recent doc contributions
- @johnthagen added example using Self to reference.
- @brson added changelog for 1.13.0 and removed platform compatibility table from the Book, link to the forge.
- @estebank fixed invalid “ref mut mut” sugestion, included type of missing trait methods in error, added note “how to escape” on fmt string with unescaped
{, removed hint to add lifetime on impl items, grouped unused import warnings per import list, showed one error for duplicated type definitions, pointed to type argument span when used as trait and reworded error when data-less enum variant called as function. - @mikhail-m1 improved “Doesn’t live long enough” error.
- @liigo marked unsafe fns in module page with superscript icons in rustdoc.
- @xfix matched guessing game output to newest language version.
- @steveklabnik made it clear that the reference isn’t normative.
- @joshtriplett documented convention for using both fmt::Write and io::Write.
- @sinkuu made E0243/E0244 message consistent with E0107.
- @QuietMisdreavus folded fields for enum struct variants into a docblock in rustdoc and added line breaks to where clauses a la rustfmt in rustdoc.
- @Mark-Simulacrum added Error implementation for std::sync::mpsc::RecvTimeoutError..
- @wesleywiser added documentation to some of the unstable intrinsics.
- @nwin removed remark about poor code style.
- @trotter updated testing.md to reflect changes to cargo new.
- @tshepang fixed doc typo.
- @est31 documented the question mark operator in reference and the Book’s syntax index.
- @GuillaumeGomez added missing urls on io structs, printed more tags in rustdoc, added missing urls for FusedIterator and TrustedLen traits, added missing urls for marker’s traits, added missing mem urls, fixed invalid src url, added missing urls and made few local rewrites and added missing urls for Sum and Product traits.
Meetings
Next meeting will be on Wednesday 16th of November 2016 at 20:00 GMT on #rust-docs channel on irc.mozilla.org. Feel free to come!