This Week in Rust Docs 3
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.
This week’s edition was edited by: GuillaumeGomez.
Latest news
We are currently talking about creating a rust docs day in order to help crates to improve/add documentation. Details remain to be done but it should be scheduled soon. Expect us!
Our “This Week in Rust Docs” seems to inspire the Haskell community as well. :)
Current opened issues
For now, here are the two big issues opened for Rust documentation:
They both need help to move forward so any contribution is very welcome!
There are currently around 50 other documentation issues opened. Look for A-docs tagged issues on github!
Recent doc contributions
- @birkenfeld improved explanations for E0432 and E0269.
- @timothy-mcroy added an explanation for E0501.
- @cristianoliveira added an explanation for E0455.
- @cramertj added explanations for E0506 and E0509.
- @steveklabnik wrote the whole new enums chapter for the new rust book!
- @Manishearth added explanations for E0408 and E0409. He also merged E0410 into E0408.
- @GuillaumeGomez removed rust flags on code blocks displayed by “rustc –explain”.
Waiting merge:
And once again, beside all this, @birkenfeld did a lot of wonderful improvements on rustdoc. Thanks to him!
- add “src” links to impls for types
- HTML-escape Rust code (from constants)
- fix inserting source code spans for constant values
- use btree map for where clauses
Alongside @birkenfeld’s improvements, @GuillaumeGomez improved the documentation’s CSS.
Meetings
Next meeting will be on Wednesday 11th of May 2016 at 20:00 GMT on #rust-docs channel on irc.mozilla.org, feel free to come!