├── 404.md
├── CNAME
├── README.md
├── _config.yml
├── _includes
├── analytics.html
├── disqus.html
├── meta.html
└── svg-icons.html
├── _layouts
├── default.html
├── page.html
└── post.html
├── _posts
├── 2016-10-16-this-week-in-rust-docs-26.md
├── 2016-10-2-this-week-in-rust-docs-24.md
├── 2016-10-23-this-week-in-rust-docs-27.md
├── 2016-10-30-this-week-in-rust-docs-28.md
├── 2016-10-9-this-week-in-rust-docs-25.md
├── 2016-11-13-this-week-in-rust-docs-30.md
├── 2016-11-20-this-week-in-rust-docs-31.md
├── 2016-11-27-this-week-in-rust-docs-32.md
├── 2016-11-6-this-week-in-rust-docs-29.md
├── 2016-12-11-this-week-in-rust-docs-34.md
├── 2016-12-18-this-week-in-rust-docs-35.md
├── 2016-12-25-this-week-in-rust-docs-36.md
├── 2016-12-4-this-week-in-rust-docs-33.md
├── 2016-4-7-this-week-in-rust-docs-1.md
├── 2016-5-1-this-week-in-rust-docs-2.md
├── 2016-5-15-this-week-in-rust-docs-4.md
├── 2016-5-22-this-week-in-rust-docs-5.md
├── 2016-5-29-this-week-in-rust-docs-6.md
├── 2016-5-8-this-week-in-rust-docs-3.md
├── 2016-6-13-this-week-in-rust-docs-8.md
├── 2016-6-21-this-week-in-rust-docs-9.md
├── 2016-6-27-this-week-in-rust-docs-10.md
├── 2016-6-6-this-week-in-rust-docs-7.md
├── 2016-7-11-this-week-in-rust-docs-12.md
├── 2016-7-18-this-week-in-rust-docs-13.md
├── 2016-7-25-this-week-in-rust-docs-14.md
├── 2016-7-4-this-week-in-rust-docs-11.md
├── 2016-8-1-this-week-in-rust-docs-15.md
├── 2016-8-15-this-week-in-rust-docs-17.md
├── 2016-8-22-this-week-in-rust-docs-18.md
├── 2016-8-29-this-week-in-rust-docs-19.md
├── 2016-8-8-this-week-in-rust-docs-16.md
├── 2016-9-11-this-week-in-rust-docs-21.md
├── 2016-9-18-this-week-in-rust-docs-22.md
├── 2016-9-25-this-week-in-rust-docs-23.md
├── 2016-9-5-this-week-in-rust-docs-20.md
├── 2017-1-1-this-week-in-rust-docs-37.md
├── 2017-1-15-this-week-in-rust-docs-39.md
├── 2017-1-22-this-week-in-rust-docs-40.md
├── 2017-1-29-this-week-in-rust-docs-41.md
├── 2017-1-8-this-week-in-rust-docs-38.md
├── 2017-10-1-this-week-in-rust-docs-75.md
├── 2017-10-15-this-week-in-rust-docs-77.md
├── 2017-10-22-this-week-in-rust-docs-78.md
├── 2017-10-29-this-week-in-rust-docs-79.md
├── 2017-10-8-this-week-in-rust-docs-76.md
├── 2017-11-12-this-week-in-rust-docs-81.md
├── 2017-11-19-this-week-in-rust-docs-82.md
├── 2017-11-26-this-week-in-rust-docs-83.md
├── 2017-11-5-this-week-in-rust-docs-80.md
├── 2017-12-10-this-week-in-rust-docs-85.md
├── 2017-12-17-this-week-in-rust-docs-86.md
├── 2017-12-3-this-week-in-rust-docs-84.md
├── 2017-2-12-this-week-in-rust-docs-43.md
├── 2017-2-19-this-week-in-rust-docs-44.md
├── 2017-2-26-this-week-in-rust-docs-45.md
├── 2017-2-5-this-week-in-rust-docs-42.md
├── 2017-3-12-this-week-in-rust-docs-47.md
├── 2017-3-19-this-week-in-rust-docs-48.md
├── 2017-3-26-this-week-in-rust-docs-49.md
├── 2017-3-5-this-week-in-rust-docs-46.md
├── 2017-4-17-this-week-in-rust-docs-52.md
├── 2017-4-2-this-week-in-rust-docs-50.md
├── 2017-4-23-this-week-in-rust-docs-53.md
├── 2017-4-30-this-week-in-rust-docs-54.md
├── 2017-4-9-this-week-in-rust-docs-51.md
├── 2017-5-14-this-week-in-rust-docs-56.md
├── 2017-5-21-this-week-in-rust-docs-57.md
├── 2017-5-28-this-week-in-rust-docs-58.md
├── 2017-5-7-this-week-in-rust-docs-55.md
├── 2017-6-11-this-week-in-rust-docs-60.md
├── 2017-6-25-this-week-in-rust-docs-61.md
├── 2017-6-3-this-week-in-rust-docs-59.md
├── 2017-7-16-this-week-in-rust-docs-64.md
├── 2017-7-2-this-week-in-rust-docs-62.md
├── 2017-7-23-this-week-in-rust-docs-65.md
├── 2017-7-30-this-week-in-rust-docs-66.md
├── 2017-7-9-this-week-in-rust-docs-63.md
├── 2017-8-13-this-week-in-rust-docs-68.md
├── 2017-8-20-this-week-in-rust-docs-69.md
├── 2017-8-27-this-week-in-rust-docs-70.md
├── 2017-8-6-this-week-in-rust-docs-67.md
├── 2017-9-10-this-week-in-rust-docs-72.md
├── 2017-9-17-this-week-in-rust-docs-73.md
├── 2017-9-24-this-week-in-rust-docs-74.md
├── 2017-9-3-this-week-in-rust-docs-71.md
├── 2018-1-14-this-week-in-rust-docs-88.md
├── 2018-1-21-this-week-in-rust-docs-89.md
├── 2018-1-28-this-week-in-rust-docs-90.md
├── 2018-1-7-this-week-in-rust-docs-87.md
├── 2018-2-11-this-week-in-rust-docs-92.md
├── 2018-2-18-this-week-in-rust-docs-93.md
├── 2018-2-25-this-week-in-rust-docs-94.md
├── 2018-2-4-this-week-in-rust-docs-91.md
├── 2018-3-11-this-week-in-rust-docs-96.md
├── 2018-3-18-this-week-in-rust-docs-97.md
├── 2018-3-25-this-week-in-rust-docs-98.md
├── 2018-3-4-this-week-in-rust-docs-95.md
├── 2018-4-1-this-week-in-rust-docs-99.md
├── 2018-4-15-this-week-in-rust-docs-101.md
├── 2018-4-22-this-week-in-rust-docs-102.md
├── 2018-4-29-this-week-in-rust-docs-103.md
├── 2018-4-8-this-week-in-rust-docs-100.md
├── 2018-5-13-this-week-in-rust-docs-105.md
├── 2018-5-21-this-week-in-rust-docs-106.md
├── 2018-5-6-this-week-in-rust-docs-104.md
└── 2018-6-3-this-week-in-rust-docs-107.md
├── _sass
├── _highlights.scss
├── _reset.scss
├── _svg-icons.scss
└── _variables.scss
├── about.md
├── feed.xml
├── images
├── 404.jpg
└── config.png
├── index.html
├── style.scss
└── updater.py
/404.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: page
3 | title: 404 - Page not found
4 | ---
5 |
6 | Sorry, we can't find that page that you're looking for. You can try again by going [back to the homepage]({{ site.baseurl }}/).
7 |
8 | [
]({{ site.baseurl }}/)
9 |
--------------------------------------------------------------------------------
/CNAME:
--------------------------------------------------------------------------------
1 |
2 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # rust-docs
2 |
3 | This is the repository where __This week in Rust docs__ is hosted. Please feel free to open a pull request or an issue if there is anything wrong or if you think that we forgot something.
--------------------------------------------------------------------------------
/_config.yml:
--------------------------------------------------------------------------------
1 | name: This week in Rust Docs
2 | title: This week in Rust Docs
3 | description: What's new with Rust's documentation.
4 | avatar: https://www.rust-lang.org/logos/rust-logo-blk.svg
5 |
6 | #
7 | # Flags below are optional
8 | #
9 |
10 | footer-links:
11 | github: guillaumegomez/this-week-in-rust-docs
12 | baseurl: "http://guillaumegomez.github.io/this-week-in-rust-docs"
13 | url: "http://guillaumegomez.github.io/this-week-in-rust-docs/"
14 |
15 | permalink: /blog/:title
16 |
17 | # Jekyll 3 now only supports Kramdown for Markdown
18 | kramdown:
19 | # Use GitHub flavored markdown, including triple backtick fenced code blocks
20 | input: GFM
21 | # Jekyll 3 and GitHub Pages now only support rouge for syntax highlighting
22 | syntax_highlighter: rouge
23 | syntax_highlighter_opts:
24 | # Use existing pygments syntax highlighting css
25 | css_class: 'highlight'
26 |
27 | # Set the Sass partials directory, as we're using @imports
28 | sass:
29 | style: :expanded
30 |
31 | gems:
32 | - jekyll-sitemap
33 | - jekyll-feed
34 |
35 | exclude:
36 | - README.md
37 |
--------------------------------------------------------------------------------
/_includes/analytics.html:
--------------------------------------------------------------------------------
1 | {% if site.google_analytics %}
2 |
3 |
15 |
16 | {% endif %}
17 |
--------------------------------------------------------------------------------
/_includes/disqus.html:
--------------------------------------------------------------------------------
1 | {% if site.disqus %}
2 |
17 | {% endif %}
--------------------------------------------------------------------------------
/_includes/meta.html:
--------------------------------------------------------------------------------
1 |
6 | {{ page.title }}
7 |
8 |
9 | {{ content }}
10 |
11 |
12 |
13 | Written on {{ page.date | date: "%B %e, %Y" }}
14 |
15 |
16 |
17 |
--------------------------------------------------------------------------------
/_posts/2016-4-7-this-week-in-rust-docs-1.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: post
3 | title: This Week in Rust Docs 1
4 | date: 2016-04-11
5 | ---
6 |
7 | Hello and welcome to *This Week in Rust Docs*!
8 |
9 | *This Week in Rust Docs* is openly developed [on GitHub](https://github.com/GuillaumeGomez/this-week-in-rust-docs).
10 | If you find any errors in this week's issue, [please submit a PR](https://github.com/GuillaumeGomez/this-week-in-rust-docs/pulls).
11 |
12 | This week's edition was edited by: [GuillaumeGomez](https://github.com/GuillaumeGomez).
13 |
14 | # Why this newsletter?
15 |
16 | There isn't an official Rust docs team yet, but several of us have decided to start working as a team, even though it's not
17 | official. Here's what we'll be working on:
18 |
19 | * Working on the front-end part of rustdoc.
20 | * Working on error code explanations.
21 | * Improving Rust documentation.
22 | * Improving the Rustbook (also known as "The Book").
23 |
24 | Since documentation is a really important part of Rust, why not keep people up-to-date about what's happening?
25 |
26 | # Latest news
27 |
28 | In the two last weeks, we opened two RFCs:
29 |
30 | * [Normalization for long error codes explanations](https://github.com/rust-lang/rfcs/pull/1567)
31 | * [More api documentation conventions](https://github.com/rust-lang/rfcs/pull/1574)
32 |
33 | Once they're approved, the work on Rust documentation will certainly increase again. They both intend to normalize how to write specific documentation. Please take a look at them. :)
34 |
35 | # Current opened issues
36 |
37 | For now, here are the issues opened for Rust documentation:
38 |
39 | * [The Standard Library Documentation Checklist](https://github.com/rust-lang/rust/issues/29329)
40 | * [Add error explanations for all error codes](https://github.com/rust-lang/rust/issues/32777)
41 |
42 | They both need help to move forward so any contribution is very welcome!
43 |
44 | # Recent doc contributions
45 |
46 | [@GuillaumeGomez](https://github.com/GuillaumeGomez) worked on both [rustdoc front-end](https://github.com/rust-lang/rust/pull/32230) and [documentation improvements](https://github.com/rust-lang/rust/pulls?utf8=%E2%9C%93&q=is%3Apr+author%3AGuillaumeGomez+is%3Aclosed+32744+32581+32464+32452+32416).
47 | [@Steveklabnik](https://github.com/steveklabnik) worked on [The Standard Library Documentation Checklist](https://github.com/rust-lang/rust/issues/29329) RFC.
48 |
49 | # Meetings
50 |
51 | Next meeting will be on Wednesday 13rd of April 2016 at 20:00 GMT on #rust-docs channel on irc.mozilla.org, feel free to come!
52 |
--------------------------------------------------------------------------------
/_posts/2016-5-1-this-week-in-rust-docs-2.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: post
3 | title: This Week in Rust Docs 2
4 | date: 2016-05-01
5 | ---
6 |
7 | Hello and welcome to *This Week in Rust Docs*!
8 |
9 | *This Week in Rust Docs* is openly developed [on GitHub](https://github.com/GuillaumeGomez/this-week-in-rust-docs).
10 | If you find any errors in this week's issue, [please submit a PR](https://github.com/GuillaumeGomez/this-week-in-rust-docs/pulls).
11 |
12 | This week's edition was edited by: [GuillaumeGomez](https://github.com/GuillaumeGomez).
13 |
14 | # Latest news
15 |
16 | Things are moving on: we talked about hosting crates' documentation directly on an official doc website (the hostname hasn't been decided yet). It has already been discussed a few times in the past but nothing came out. For now, we're mostly trying to sort through all of the complexity. A lot of details must be taken in account and it is still at a very early stage of discussion but it started!
17 |
18 | The [pull request](https://github.com/rust-lang/rust/pull/32756) on the new rustc output is finally here (or almost)!
19 |
20 | [@jonathandturner](https://github.com/jonathandturner) and [@peschkaj](https://github.com/peschkaj) are working on a style guide in order to help developers to write better library documentations.
21 |
22 | Besides this, [@peschkaj](https://github.com/peschkaj) investigated the current doc status of the 20 biggest crates (based on number of downloads on [crates.io](https://crates.io)). Take a look at the report [The State of Rust Docs](https://facility9.com/2016/04/the-state-of-rust-docs-2016/).
23 |
24 | # Current opened issues
25 |
26 | For now, here are the issues opened for Rust documentation:
27 |
28 | * [The Standard Library Documentation Checklist](https://github.com/rust-lang/rust/issues/29329)
29 | * [Add error explanations for all error codes](https://github.com/rust-lang/rust/issues/32777)
30 |
31 | They both need help to move forward so any contribution is very welcome!
32 |
33 | # Recent doc contributions
34 |
35 | * [@timothy-mcroy](https://github.com/timothy-mcroy) added [E0434](https://github.com/rust-lang/rust/pull/33229) and [E0501](https://github.com/rust-lang/rust/pull/33294) errors explanation.
36 | * [@birkenfeld](https://github.com/birkenfeld) improved [E0269](https://github.com/rust-lang/rust/pull/33324) and [E0432](https://github.com/rust-lang/rust/pull/33320) errors explanation and fixed [std::thread docs](https://github.com/rust-lang/rust/pull/33326). He also clarified [std::fmt dollar syntax](https://github.com/rust-lang/rust/pull/33258).
37 | * [@mrmiywj](https://github.com/mrmiywj) improved [E0008 error explanation](https://github.com/rust-lang/rust/pull/33260).
38 | * [@bwinterton](https://github.com/bwinterton) improved [BTreeSet::Insert](https://github.com/rust-lang/rust/pull/33276) doc.
39 | * [@durka](https://github.com/durka) worked on [tuple/unit structs](https://github.com/rust-lang/rust/pull/33250) in the rustbook.
40 | * [@benaryorg](https://github.com/benaryorg) clarified documentation of [TcpStream::connect for multiple valid addresses](https://github.com/rust-lang/rust/pull/33167).
41 | * [@fitzgen](https://github.com/fitzgen) clarified [Iterator::enumerate doc example](https://github.com/rust-lang/rust/pull/33085).
42 | * [@GuillaumeGomez](https://github.com/GuillaumeGomez)'s [Pull Request](https://github.com/rust-lang/rust/pull/32230) to add the `--extend-css` option to rustdoc has been merged. He also worked on [process types documentation](https://github.com/rust-lang/rust/pull/33283).
43 |
44 | Besides all this, a lot of improvements have been made to rustdoc source code:
45 |
46 | * [Linkify extern crates](https://github.com/rust-lang/rust/pull/33196)
47 | * [Improve accessibility of rustdoc pages](https://github.com/rust-lang/rust/pull/33194)
48 | * [Handle concurrent mkdir requests](https://github.com/rust-lang/rust/pull/33191)
49 | * [Only record the same impl once](https://github.com/rust-lang/rust/pull/33153)
50 | * [Inline all the impls](https://github.com/rust-lang/rust/pull/33133)
51 |
52 | # Meetings
53 |
54 | Next meeting will be on Wednesday 4th of May 2016 at 20:00 GMT on #rust-docs channel on irc.mozilla.org, feel free to come!
55 |
--------------------------------------------------------------------------------
/_posts/2016-5-15-this-week-in-rust-docs-4.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: post
3 | title: This Week in Rust Docs 4
4 | date: 2016-05-15
5 | ---
6 |
7 | Hello and welcome to *This Week in Rust Docs*!
8 |
9 | *This Week in Rust Docs* is openly developed [on GitHub](https://github.com/GuillaumeGomez/this-week-in-rust-docs).
10 | If you find any errors in this week's issue, [please submit a PR](https://github.com/GuillaumeGomez/this-week-in-rust-docs/pulls).
11 |
12 | This week's edition was edited by: [GuillaumeGomez](https://github.com/GuillaumeGomez).
13 |
14 | # Latest news
15 |
16 | The whole new error format landed! Take a look [here](https://internals.rust-lang.org/t/new-error-format/3438) for more information.
17 |
18 | [@peschakj](https://github.com/peschkaj) posted [Writing Documentation in Rust](https://facility9.com/2016/05/writing-documentation-in-rust/).
19 |
20 | # Current opened issues
21 |
22 | For now, here are the two big issues opened for Rust documentation:
23 |
24 | * [The Standard Library Documentation Checklist](https://github.com/rust-lang/rust/issues/29329)
25 | * [Add error explanations for all error codes](https://github.com/rust-lang/rust/issues/32777)
26 |
27 | They both need help to move forward so any contribution is very welcome!
28 |
29 | There are currently around 50 other documentation issues opened. Look for [A-docs](https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AA-docs) tagged issues on github!
30 |
31 | # Recent doc contributions
32 |
33 | * [@cramertj](https://github.com/cramertj) added explanation for [E0389](https://github.com/rust-lang/rust/pull/33412).
34 | * [@dfockler](https://github.com/dfockler) added explanation for [E0374, E0375, E0376](https://github.com/rust-lang/rust/pull/33415).
35 | * [@billyevans](https://github.com/billyevans) added explanation for [E0505](https://github.com/rust-lang/rust/pull/33475).
36 | * [@cramertj](https://github.com/cramertj) added explanation for [E0504](https://github.com/rust-lang/rust/pull/33386).
37 | * [@GuillaumeGomez](https://github.com/GuillaumeGomez) added explanation for [E0500](https://github.com/rust-lang/rust/pull/33533), improved the help for the [Makefile](https://github.com/rust-lang/rust/pull/33489), added [lifetime's bounds display in generated documentation](https://github.com/rust-lang/rust/pull/33656), added [more details and examples in error codes](https://github.com/rust-lang/rust/pull/33584) and added [compile-fail tests for error codes](https://github.com/rust-lang/rust/pull/33585).
38 |
39 | [@birkenfeld](https://github.com/birkenfeld) continues his awesome work on rustdoc:
40 |
41 | * [display field types together with names in detailed docs](https://github.com/rust-lang/rust/pull/33377)
42 | * [do not panic all the way when lexing a source snippet fails](https://github.com/rust-lang/rust/pull/33510)
43 | * [inject `#[macro_use] extern crate` in doctests for macros](https://github.com/rust-lang/rust/pull/33511)
44 | * [remove artificial indentation of doctest code ](https://github.com/rust-lang/rust/pull/33512)
45 | * [add a "primitive type reference" page](https://github.com/rust-lang/rust/pull/33516)
46 |
47 | And once again, [@GuillaumeGomez](https://github.com/GuillaumeGomez) worked on the [rustdoc CSS](https://github.com/rust-lang/rust/pull/33542).
48 |
49 | # Meetings
50 |
51 | Next meeting will be on Wednesday 18th of May 2016 at 20:00 GMT on #rust-docs channel on irc.mozilla.org, feel free to come!
52 |
--------------------------------------------------------------------------------
/_posts/2016-5-22-this-week-in-rust-docs-5.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: post
3 | title: This Week in Rust Docs 5
4 | date: 2016-05-21
5 | ---
6 |
7 | Hello and welcome to *This Week in Rust Docs*!
8 |
9 | *This Week in Rust Docs* is openly developed [on GitHub](https://github.com/GuillaumeGomez/this-week-in-rust-docs).
10 | If you find any errors in this week's issue, [please submit a PR](https://github.com/GuillaumeGomez/this-week-in-rust-docs/pulls).
11 |
12 | And of course, don't forget to look at the docs:
13 |
14 | * [Stable](https://doc.rust-lang.org/)
15 | * [Beta](http://doc.rust-lang.org/beta/)
16 | * [Nightly](http://doc.rust-lang.org/nightly/)
17 |
18 | This week's edition was edited by: [GuillaumeGomez](https://github.com/GuillaumeGomez).
19 |
20 | # Latest news
21 |
22 | The [Normalization for long error codes explanations RFC](https://github.com/rust-lang/rfcs/pull/1567) entered its final comment period!
23 |
24 | [@pnkfelix](https://github.com/pnkfelix) proposed [to rewrite all the code examples to be song of fire and internal-compiler-error themed](https://github.com/rust-lang/rust/pull/33675#issuecomment-219609913). I think we'll try to put it in place! :p
25 |
26 | # Current opened issues
27 |
28 | For now, here are the two big issues opened for Rust documentation:
29 |
30 | * [The Standard Library Documentation Checklist](https://github.com/rust-lang/rust/issues/29329)
31 | * [Add error explanations for all error codes](https://github.com/rust-lang/rust/issues/32777)
32 |
33 | They both need help to move forward so any contribution is very welcome!
34 |
35 | There are currently around 50 other documentation issues opened. Look for [A-docs](https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AA-docs) tagged issues on github!
36 |
37 | # Recent doc contributions
38 |
39 | We had a busy week, thanks to all contributors!
40 |
41 | * [@Manishearth](https://github.com/Manishearth) added [doc snippets for trait impls, with a read more link](https://github.com/rust-lang/rust/pull/33679)
42 | * [@lqd](https://github.com/lqd) made [the #[stable(since)] version attribute clearer with a tooltip](https://github.com/rust-lang/rust/pull/33705).
43 | * [@golddranks](https://github.com/golddranks) added [a big-picture explanation for thread::park() & co.](https://github.com/rust-lang/rust/pull/33665).
44 | * [@rkruppe](https://github.com/rkruppe) reworded the [short diagnostic for E0509](https://github.com/rust-lang/rust/pull/33676).
45 | * [@tshepang](https://github.com/tshepang) made a lot of small improvements. Take a look [here](https://github.com/rust-lang/rust/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aclosed+33603+33604+33605+33633+33634+33635) to see the list!
46 | * [@alex-ozdemir](https://github.com/alex-ozdemir) added [a `rustdoc` shortcut for collapse/expand all](https://github.com/rust-lang/rust/pull/33765).
47 | * [@postmodern](https://github.com/postmodern) clarified [the English translation of `?Sized`](https://github.com/rust-lang/rust/pull/33747).
48 | * [@crimsun](https://github.com/crimsun) resolved [a rustdoc crash](https://github.com/rust-lang/rust/pull/33702).
49 | * [@dns2utf8](https://github.com/dns2utf8) clarified [docs for sort(&mut self)](https://github.com/rust-lang/rust/pull/33746).
50 | * [@GuillaumeGomez](https://github.com/GuillaumeGomez) added [lifetime's bounds in doc generation](https://github.com/rust-lang/rust/pull/33656), fixed [compile_fail tag](https://github.com/rust-lang/rust/pull/33793), added [new error code tests](https://github.com/rust-lang/rust/pull/33781), updated [repr_simd feature in errors explanation](https://github.com/rust-lang/rust/pull/33779) and fixed a [CSS bug](https://github.com/rust-lang/rust/pull/33673).
51 |
52 | # Meetings
53 |
54 | Next meeting will be on Wednesday 25th of May 2016 at 20:00 GMT on #rust-docs channel on irc.mozilla.org, feel free to come!
55 |
--------------------------------------------------------------------------------
/_posts/2016-5-29-this-week-in-rust-docs-6.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: post
3 | title: This Week in Rust Docs 6
4 | date: 2016-05-29
5 | ---
6 |
7 | Hello and welcome to *This Week in Rust Docs*!
8 |
9 | *This Week in Rust Docs* is openly developed [on GitHub](https://github.com/GuillaumeGomez/this-week-in-rust-docs).
10 | If you find any errors in this week's issue, [please submit a PR](https://github.com/GuillaumeGomez/this-week-in-rust-docs/pulls).
11 |
12 | And of course, don't forget to look at the docs:
13 |
14 | * [Stable](https://doc.rust-lang.org/)
15 | * [Beta](http://doc.rust-lang.org/beta/)
16 | * [Nightly](http://doc.rust-lang.org/nightly/)
17 |
18 | This week's edition was edited by: [GuillaumeGomez](https://github.com/GuillaumeGomez).
19 |
20 | # Latest news
21 |
22 | The [Normalization for long error codes explanations RFC](https://github.com/rust-lang/rfcs/pull/1567) is still in its final comment period!
23 |
24 | The "doc days" are still in the center of our last meetings. More information will come soon!
25 |
26 | # Current opened issues
27 |
28 | For now, here are the two big issues opened for Rust documentation:
29 |
30 | * [The Standard Library Documentation Checklist](https://github.com/rust-lang/rust/issues/29329)
31 | * [Add error explanations for all error codes](https://github.com/rust-lang/rust/issues/32777)
32 |
33 | They both need help to move forward so any contribution is very welcome!
34 |
35 | There are currently around 50 other documentation issues opened. Look for [A-docs](https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AA-docs) tagged issues on github!
36 |
37 | # Waiting merge
38 |
39 | * [@zackmdavis](https://github.com/zackmdavis) added [explanation for E0429](https://github.com/rust-lang/rust/pull/33955).
40 | * [@estebank](https://github.com/estebank) added [specific error message for missplaced doc comments](https://github.com/rust-lang/rust/pull/33922).
41 | * [@cristianoliveira](https://github.com/cristianoliveira) added [E0174 error explanation](https://github.com/rust-lang/rust/pull/33920).
42 | * [@GuillaumeGomez](https://github.com/GuillaumeGomez) fixed [invalid trait generation in rustdoc](https://github.com/rust-lang/rust/pull/33935), added [new error code tests](https://github.com/rust-lang/rust/pull/33915) and improved [help message for E0425](https://github.com/rust-lang/rust/pull/33878).
43 |
44 | # Recent doc contributions
45 |
46 | * [@oli-obk](https://github.com/oli-obk) added [display for enum variant fields in docs](https://github.com/rust-lang/rust/pull/33867).
47 | * [@kennytm](https://github.com/kennytm) improved [`fs::read_dir()` example](https://github.com/rust-lang/rust/pull/33958).
48 | * [@Ophirr33](https://github.com/Ophirr33) added [examples/docs to split in str.rs](https://github.com/rust-lang/rust/pull/33893).
49 | * [@GuillaumeGomez](https://github.com/GuillaumeGomez) improved [E0084](https://github.com/rust-lang/rust/pull/33865), , added [new error code tests](https://github.com/rust-lang/rust/pull/33866), fixed [invalid background color in stability elements](https://github.com/rust-lang/rust/pull/33829), fixed [compile_fail tag](https://github.com/rust-lang/rust/pull/33793) and also added [E0132](https://github.com/rust-lang/rust/pull/33912), [E0133](https://github.com/rust-lang/rust/pull/33913) and a few [others](https://github.com/rust-lang/rust/pull/33914) errors explanation.
50 |
51 | # Meetings
52 |
53 | Next meeting will be on Wednesday 1st of June 2016 at 20:00 GMT on #rust-docs channel on irc.mozilla.org. Feel free to come!
54 |
--------------------------------------------------------------------------------
/_posts/2016-5-8-this-week-in-rust-docs-3.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: post
3 | title: This Week in Rust Docs 3
4 | date: 2016-05-08
5 | ---
6 |
7 | Hello and welcome to *This Week in Rust Docs*!
8 |
9 | *This Week in Rust Docs* is openly developed [on GitHub](https://github.com/GuillaumeGomez/this-week-in-rust-docs).
10 | If you find any errors in this week's issue, [please submit a PR](https://github.com/GuillaumeGomez/this-week-in-rust-docs/pulls).
11 |
12 | This week's edition was edited by: [GuillaumeGomez](https://github.com/GuillaumeGomez).
13 |
14 | # Latest news
15 |
16 | 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!
17 |
18 | Our "This Week in Rust Docs" seems to [inspire the Haskell community](https://www.reddit.com/r/haskell/comments/4hmjnp/this_week_in_haskell_docs/) as well. :)
19 |
20 | # Current opened issues
21 |
22 | For now, here are the two big issues opened for Rust documentation:
23 |
24 | * [The Standard Library Documentation Checklist](https://github.com/rust-lang/rust/issues/29329)
25 | * [Add error explanations for all error codes](https://github.com/rust-lang/rust/issues/32777)
26 |
27 | They both need help to move forward so any contribution is very welcome!
28 |
29 | There are currently around 50 other documentation issues opened. Look for [A-docs](https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AA-docs) tagged issues on github!
30 |
31 | # Recent doc contributions
32 |
33 | * [@birkenfeld](https://github.com/birkenfeld) improved explanations for [E0432](https://github.com/rust-lang/rust/pull/33320) and [E0269](https://github.com/rust-lang/rust/pull/33324).
34 | * [@timothy-mcroy](https://github.com/timothy-mcroy) added an explanation for [E0501](https://github.com/rust-lang/rust/pull/33294#event-650972625).
35 | * [@cristianoliveira](https://github.com/cristianoliveira) added an explanation for [E0455](https://github.com/rust-lang/rust/pull/33393).
36 | * [@cramertj](https://github.com/cramertj) added explanations for [E0506](https://github.com/rust-lang/rust/pull/33384) and [E0509](https://github.com/rust-lang/rust/pull/33383).
37 | * [@steveklabnik](https://github.com/steveklabnik) wrote the whole new [enums chapter](https://github.com/rust-lang/book/pull/98/files) for the new rust book!
38 | * [@Manishearth](https://github.com/Manishearth) added explanations for [E0408 and E0409](https://github.com/rust-lang/rust/pull/33493). He also merged E0410 into E0408.
39 | * [@GuillaumeGomez](https://github.com/rust-lang/rust/pull/33410) removed rust flags on code blocks displayed by "rustc --explain".
40 |
41 | Waiting merge:
42 |
43 | * [@cramertj](https://github.com/cramertj): [E0504](https://github.com/rust-lang/rust/pull/33386)
44 | * [@dfockler](https://github.com/dfockler): [E0374, E0375, E0376](https://github.com/rust-lang/rust/pull/33415)
45 | * [@billyevans](https://github.com/billyevans): [E0505](https://github.com/rust-lang/rust/pull/33475)
46 |
47 | And once again, beside all this, [@birkenfeld](https://github.com/birkenfeld) did a lot of wonderful improvements on rustdoc. Thanks to him!
48 |
49 | * [add "src" links to impls for types](https://github.com/rust-lang/rust/pull/33382)
50 | * [HTML-escape Rust code (from constants)](https://github.com/rust-lang/rust/pull/33372)
51 | * [fix inserting source code spans for constant values](https://github.com/rust-lang/rust/pull/33371)
52 | * [use btree map for where clauses](https://github.com/rust-lang/rust/pull/33373)
53 |
54 | Alongside [@birkenfeld](https://github.com/birkenfeld)'s improvements, [@GuillaumeGomez](https://github.com/rust-lang/rust/pull/33410) improved the [documentation's CSS](https://github.com/rust-lang/rust/pull/33431).
55 |
56 | # Meetings
57 |
58 | 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!
59 |
--------------------------------------------------------------------------------
/_posts/2016-6-13-this-week-in-rust-docs-8.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: post
3 | title: This Week in Rust Docs 8
4 | date: 2016-06-13
5 | ---
6 |
7 | Hello and welcome to *This Week in Rust Docs*!
8 |
9 | *This Week in Rust Docs* is openly developed [on GitHub](https://github.com/GuillaumeGomez/this-week-in-rust-docs).
10 | If you find any errors in this week's issue, [please submit a PR](https://github.com/GuillaumeGomez/this-week-in-rust-docs/pulls).
11 |
12 | And of course, don't forget to look at the docs:
13 |
14 | * [Stable](https://doc.rust-lang.org/)
15 | * [Beta](http://doc.rust-lang.org/beta/)
16 | * [Nightly](http://doc.rust-lang.org/nightly/)
17 |
18 | This week's edition was edited by: [GuillaumeGomez](https://github.com/GuillaumeGomez).
19 |
20 | # Latest news
21 |
22 | The "doc days" event is now set for the 24th and 25th of June! Any contribution is very welcome. You can find more information [here](https://facility9.com/2016/06/announcing-rust-doc-days/).
23 |
24 | # Current opened issues
25 |
26 | For now, here are the two big issues opened for Rust documentation:
27 |
28 | * [The Standard Library Documentation Checklist](https://github.com/rust-lang/rust/issues/29329)
29 | * [Add error explanations for all error codes](https://github.com/rust-lang/rust/issues/32777)
30 |
31 | They both need help to move forward so any contribution is very welcome!
32 |
33 | There are currently around 50 other documentation issues opened. Look for [A-docs](https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AA-docs) tagged issues on github!
34 |
35 | # Call for participation
36 |
37 | The [following issue](https://github.com/rust-lang/rust/issues/33772) (a really important one!) is blocked for the moment. Any help on it would be very appreciated!
38 |
39 | # Waiting for merge
40 |
41 | * [@estebank](https://github.com/estebank) added [specific error message for missplaced doc comments](https://github.com/rust-lang/rust/pull/33922).
42 | * [@ollie27](https://github.com/ollie27) removed [Remove Derived Implementations title](https://github.com/rust-lang/rust/pull/34105), fixed [redirect pages for renamed reexports](https://github.com/rust-lang/rust/pull/34245) and removed [inline for `#[doc(hidden)] pub use`](https://github.com/rust-lang/rust/pull/34232).
43 | * [@cynicaldevil](https://github.com/cynicaldevil) added [explanation for E0406](https://github.com/rust-lang/rust/pull/34230).
44 | * [@zackmdavis](https://github.com/zackmdavis) added [explanation for E0453](https://github.com/rust-lang/rust/pull/34242).
45 | * [@GuillaumeGomez](https://github.com/GuillaumeGomez) fixed [invalid trait generation in rustdoc](https://github.com/rust-lang/rust/pull/33935), fixed [invalid inlining](https://github.com/rust-lang/rust/pull/34234) and implemented [the error code checker](https://github.com/rust-lang/rust/pull/34186).
46 |
47 | # Recent doc contributions
48 |
49 | * [@m-decoster](https://github.com/m-decoster) added explanations for [E0503 and E0508](https://github.com/rust-lang/rust/pull/34133).
50 | * [@hoodie](https://github.com/hoodie) fixed [bool color](https://github.com/rust-lang/rust/pull/34138) and fixed [bad spelling of "Jon Snow" and "Night's Watch"](https://github.com/rust-lang/rust/pull/34160). (Damn! It was a close call!!)
51 | * [@MichaelNecio](https://github.com/MichaelNecio) noted that [shadowing never destroys a value](https://github.com/rust-lang/rust/pull/34125).
52 | * [@matklad](https://github.com/matklad) simplified [wording](https://github.com/rust-lang/rust/pull/34145).
53 | * [@withoutboats](https://github.com/withoutboats) corrected [the docs on str::trim_matches](https://github.com/rust-lang/rust/pull/33645).
54 | * [@kennytm](https://github.com/kennytm) fixed [markdown formatting error of E0277, E0310 and E0502](https://github.com/rust-lang/rust/pull/34161).
55 | * [@ollie27](https://github.com/ollie27) fixed [rustdoc static and const generation of redirect pages](https://github.com/rust-lang/rust/pull/34068) and improved [`char::to_{lower,upper}case` examples](https://github.com/rust-lang/rust/pull/34165).
56 |
57 | # Meetings
58 |
59 | Next meeting will be on Wednesday 15th of June 2016 at 20:00 GMT on #rust-docs channel on irc.mozilla.org. Feel free to come!
60 |
--------------------------------------------------------------------------------
/_posts/2016-6-21-this-week-in-rust-docs-9.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: post
3 | title: This Week in Rust Docs 9
4 | date: 2016-06-21
5 | ---
6 |
7 | Hello and welcome to *This Week in Rust Docs*!
8 |
9 | *This Week in Rust Docs* is openly developed [on GitHub](https://github.com/GuillaumeGomez/this-week-in-rust-docs).
10 | If you find any errors in this week's issue, [please submit a PR](https://github.com/GuillaumeGomez/this-week-in-rust-docs/pulls).
11 |
12 | And of course, don't forget to look at the docs:
13 |
14 | * [Stable](https://doc.rust-lang.org/)
15 | * [Beta](http://doc.rust-lang.org/beta/)
16 | * [Nightly](http://doc.rust-lang.org/nightly/)
17 |
18 | This week's edition was edited by: [GuillaumeGomez](https://github.com/GuillaumeGomez).
19 |
20 | # Latest news
21 |
22 | The [Normalization for long error codes explanations](https://github.com/rust-lang/rfcs/pull/1567) RFC has been accepted!
23 |
24 | The [More api documentation conventions](https://github.com/rust-lang/rfcs/pull/1574) has entered its final comment period!
25 |
26 | The "doc days" event is now set for the 24th and 25th of June! Any contribution is very welcome. You can find more information [here](https://facility9.com/2016/06/announcing-rust-doc-days/).
27 |
28 | # Current opened issues
29 |
30 | For now, here are the two big issues opened for Rust documentation:
31 |
32 | * [The Standard Library Documentation Checklist](https://github.com/rust-lang/rust/issues/29329)
33 | * [Add error explanations for all error codes](https://github.com/rust-lang/rust/issues/32777)
34 |
35 | They both need help to move forward so any contribution is very welcome!
36 |
37 | There are currently around 50 other documentation issues opened. Look for [A-docs](https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AA-docs) tagged issues on github!
38 |
39 | # Call for participation
40 |
41 | There's now a call for participation to [display all methods of a type, even those from implicit traits](https://github.com/rust-lang/rust/issues/33772). This is a great way to help users find everything that a type can do. Any help on it would be very appreciated!
42 |
43 | # Waiting for merge
44 |
45 | * [@estebank](https://github.com/estebank) added [specific error message for missplaced doc comments](https://github.com/rust-lang/rust/pull/33922).
46 | * [@ollie27](https://github.com/ollie27) removed [Remove Derived Implementations title](https://github.com/rust-lang/rust/pull/34105) and added [more types to the rustdoc sidebar](https://github.com/rust-lang/rust/pull/34372).
47 | * [@GuillaumeGomez](https://github.com/GuillaumeGomez) added [error code flags](https://github.com/rust-lang/rust/pull/34401).
48 |
49 | # Recent doc contributions
50 |
51 | * [@zackmdavis](https://github.com/zackmdavis) added [explanation for E0453](https://github.com/rust-lang/rust/pull/34242).
52 | * [@frewsxcv](https://github.com/frewsxcv) added [example in docs for `std::thread::panicking`](https://github.com/rust-lang/rust/pull/34313).
53 | * [@tshepang](https://github.com/tshepang) fixed [mis-named binding & remove not needed `mut`](https://github.com/rust-lang/rust/pull/34314).
54 | * [@fbergr](https://github.com/fbergr) fixed [a typo](https://github.com/rust-lang/rust/pull/34259).
55 | * [@ollie27](https://github.com/ollie27) fixed [redirect pages for renamed reexports](https://github.com/rust-lang/rust/pull/34245), added [short summaries to btree modules](https://github.com/rust-lang/rust/pull/34335), added [stability notices to impl items](https://github.com/rust-lang/rust/pull/34292), improved [IP reserved address docs](https://github.com/rust-lang/rust/pull/34263), fixed [redirect pages for renamed reexports in rustdoc](https://github.com/rust-lang/rust/pull/34245) and removed [inline for `#[doc(hidden)] pub use`](https://github.com/rust-lang/rust/pull/34232).
56 | * [@GuillaumeGomez](https://github.com/GuillaumeGomez) fixed [invalid inlining](https://github.com/rust-lang/rust/pull/34234), removed [unused E0406 and unused functions](https://github.com/rust-lang/rust/pull/34342) and implemented [the error code checker](https://github.com/rust-lang/rust/pull/34186).
57 |
58 | # Meetings
59 |
60 | Next meeting will be on Wednesday 22th of June 2016 at 20:00 GMT on #rust-docs channel on irc.mozilla.org. Feel free to come!
61 |
--------------------------------------------------------------------------------
/_posts/2016-6-27-this-week-in-rust-docs-10.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: post
3 | title: This Week in Rust Docs 10
4 | date: 2016-06-27
5 | ---
6 |
7 | Hello and welcome to *This Week in Rust Docs*!
8 |
9 | *This Week in Rust Docs* is openly developed [on GitHub](https://github.com/GuillaumeGomez/this-week-in-rust-docs).
10 | If you find any errors in this week's issue, [please submit a PR](https://github.com/GuillaumeGomez/this-week-in-rust-docs/pulls).
11 |
12 | And of course, don't forget to look at the docs:
13 |
14 | * [Stable](https://doc.rust-lang.org/)
15 | * [Beta](http://doc.rust-lang.org/beta/)
16 | * [Nightly](http://doc.rust-lang.org/nightly/)
17 |
18 | This week's edition was edited by: [GuillaumeGomez](https://github.com/GuillaumeGomez).
19 |
20 | # Latest news
21 |
22 | The "doc days" event is now over. Thanks to everyone who contributed! Here is a list of the contributions:
23 |
24 | * [tempdir](https://github.com/rust-lang-nursery/tempdir/pull/11)
25 | * [unix-socket](https://github.com/rust-lang-nursery/unix-socket/pull/26)
26 | * [uuid (1)](https://github.com/rust-lang-nursery/uuid/pull/65) and [uuid (2)](https://github.com/rust-lang-nursery/uuid/pull/64)
27 | * [glob](https://github.com/rust-lang-nursery/glob/pull/53)
28 | * [rand](https://github.com/rust-lang-nursery/rand/pull/106)
29 | * [rustc-serialize](https://github.com/rust-lang-nursery/rustc-serialize/pull/153)
30 |
31 | # Current opened issues
32 |
33 | For now, here are the two big issues opened for Rust documentation:
34 |
35 | * [The Standard Library Documentation Checklist](https://github.com/rust-lang/rust/issues/29329)
36 | * [Add error explanations for all error codes](https://github.com/rust-lang/rust/issues/32777)
37 |
38 | They both need help to move forward so any contribution is very welcome!
39 |
40 | There are currently around 50 other documentation issues opened. Look for [A-docs](https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AA-docs) tagged issues on github!
41 |
42 | # Call for participation
43 |
44 | There's now a call for participation to [display all methods of a type, even those from implicit traits](https://github.com/rust-lang/rust/issues/33772). This is a great way to help users find everything that a type can do. Any help on it would be very appreciated!
45 |
46 | # Waiting for merge
47 |
48 | * [@tatsuya6502](https://github.com/tatsuya6502) fixed [links in Ownership section of the book](https://github.com/rust-lang/rust/pull/34442).
49 | * [@ubsan](https://github.com/ubsan) fixed [ABI string docs in reference.md](https://github.com/rust-lang/rust/pull/34461).
50 | * [@dns2utf8](https://github.com/dns2utf8) added [example with leading zeros](https://github.com/rust-lang/rust/pull/34462).
51 | * [@frewsxcv](https://github.com/frewsxcv) expanded [`std::path::Component` documentation](https://github.com/rust-lang/rust/pull/34475) and added [example for `std::thread::sleep`](https://github.com/rust-lang/rust/pull/34406).
52 | * [@estebank](https://github.com/estebank) added [specific error message for missplaced doc comments](https://github.com/rust-lang/rust/pull/33922).
53 | * [@ollie27](https://github.com/ollie27) fixed [inlined renamed reexports in import lists](https://github.com/rust-lang/rust/pull/34479), fixed [float examples](https://github.com/rust-lang/rust/pull/34415), fixed [search result layout for enum variants and struct fields](https://github.com/rust-lang/rust/pull/34477) and removed [Remove Derived Implementations title](https://github.com/rust-lang/rust/pull/34105).
54 | * [@GuillaumeGomez](https://github.com/GuillaumeGomez) fixed [E0269 explanation](https://github.com/rust-lang/rust/pull/34471) and added [new error codes and improve some explanations](https://github.com/rust-lang/rust/pull/34467).
55 |
56 | # Recent doc contributions
57 |
58 | * [@frewsxcv](https://github.com/frewsxcv) indicated [how the `std::path::Components` struct is created](https://github.com/rust-lang/rust/pull/34469), indicated [how the `JoinHandle` struct is created](https://github.com/rust-lang/rust/pull/34438), fixed [doc parameters formatting](https://github.com/rust-lang/rust/pull/34410), added [doc example for `std::thread::Builder::name`](https://github.com/rust-lang/rust/pull/34465) and added [hyperlinks to `std::fs` functions from `std::path`](https://github.com/rust-lang/rust/pull/34468).
59 | * [@liigo](https://github.com/liigo) updated [rustc-ux-guidelines](https://github.com/rust-lang/rust/pull/34378) and improved [E0425 explanation](https://github.com/rust-lang/rust/pull/34379).
60 | * [@cynicaldevil](https://github.com/cynicaldevil) modified E0220 [to show error messages for more general cases](https://github.com/rust-lang/rust/pull/34364).
61 | * [@ollie27](https://github.com/ollie27) added [more types to the rustdoc sidebar](https://github.com/rust-lang/rust/pull/34372), fixed [panic caused by doc(hidden) trait methods](https://github.com/rust-lang/rust/pull/34439) and fixed [a couple of issues with src links to external crates](https://github.com/rust-lang/rust/pull/34387).
62 | * [@GuillaumeGomez](https://github.com/GuillaumeGomez) added [error code flags](https://github.com/rust-lang/rust/pull/34401).
63 |
64 | # Meetings
65 |
66 | Next meeting will be on Wednesday 29th of June 2016 at 20:00 GMT on #rust-docs channel on irc.mozilla.org. Feel free to come!
67 |
--------------------------------------------------------------------------------
/_posts/2016-6-6-this-week-in-rust-docs-7.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: post
3 | title: This Week in Rust Docs 7
4 | date: 2016-06-06
5 | ---
6 |
7 | Hello and welcome to *This Week in Rust Docs*!
8 |
9 | *This Week in Rust Docs* is openly developed [on GitHub](https://github.com/GuillaumeGomez/this-week-in-rust-docs).
10 | If you find any errors in this week's issue, [please submit a PR](https://github.com/GuillaumeGomez/this-week-in-rust-docs/pulls).
11 |
12 | And of course, don't forget to look at the docs:
13 |
14 | * [Stable](https://doc.rust-lang.org/)
15 | * [Beta](http://doc.rust-lang.org/beta/)
16 | * [Nightly](http://doc.rust-lang.org/nightly/)
17 |
18 | This week's edition was edited by: [GuillaumeGomez](https://github.com/GuillaumeGomez).
19 |
20 | # Latest news
21 |
22 | The "doc days" event is now set for the 24th and 25th of June! Any contribution is very welcome. You can find more information [here](https://facility9.com/2016/06/announcing-rust-doc-days/).
23 |
24 | # Current opened issues
25 |
26 | For now, here are the two big issues opened for Rust documentation:
27 |
28 | * [The Standard Library Documentation Checklist](https://github.com/rust-lang/rust/issues/29329)
29 | * [Add error explanations for all error codes](https://github.com/rust-lang/rust/issues/32777)
30 |
31 | They both need help to move forward so any contribution is very welcome!
32 |
33 | There are currently around 50 other documentation issues opened. Look for [A-docs](https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AA-docs) tagged issues on github!
34 |
35 | # Waiting for merge
36 |
37 | * [@estebank](https://github.com/estebank) added [specific error message for missplaced doc comments](https://github.com/rust-lang/rust/pull/33922).
38 | * [@GuillaumeGomez](https://github.com/GuillaumeGomez) fixed [invalid trait generation in rustdoc](https://github.com/rust-lang/rust/pull/33935).
39 |
40 | # Recent doc contributions
41 |
42 | * [@cristianoliveira](https://github.com/cristianoliveira) added [E0174 error explanation](https://github.com/rust-lang/rust/pull/33920).
43 | * [@zackmdavis](https://github.com/zackmdavis) added [explanation for E0429](https://github.com/rust-lang/rust/pull/33955).
44 | * [@oconnor663](https://github.com/oconnor663) documented [that Files close themselves automatically](https://github.com/rust-lang/rust/pull/33993).
45 | * [@ollie27](https://github.com/ollie27) removed [generation of empty files for stripped items](https://github.com/rust-lang/rust/pull/34045) and fixed [a few links in the book](https://github.com/rust-lang/rust/pull/34021).
46 | * [@GuillaumeGomez](https://github.com/GuillaumeGomez) added [new error code tests](https://github.com/rust-lang/rust/pull/33915), fixed [E0165 code examples](https://github.com/rust-lang/rust/pull/34014) and improved [help message for E0425](https://github.com/rust-lang/rust/pull/33878).
47 |
48 | # Meetings
49 |
50 | Next meeting will be on Wednesday 8th of June 2016 at 20:00 GMT on #rust-docs channel on irc.mozilla.org. Feel free to come!
51 |
--------------------------------------------------------------------------------
/_posts/2016-7-11-this-week-in-rust-docs-12.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: post
3 | title: This Week in Rust Docs 12
4 | date: 2016-07-11
5 | ---
6 |
7 | Hello and welcome to *This Week in Rust Docs*!
8 |
9 | *This Week in Rust Docs* is openly developed [on GitHub](https://github.com/GuillaumeGomez/this-week-in-rust-docs).
10 | If you find any errors in this week's issue, [please submit a PR](https://github.com/GuillaumeGomez/this-week-in-rust-docs/pulls).
11 |
12 | And of course, don't forget to look at the docs:
13 |
14 | * [Stable](https://doc.rust-lang.org/)
15 | * [Beta](http://doc.rust-lang.org/beta/)
16 | * [Nightly](http://doc.rust-lang.org/nightly/)
17 |
18 | This week's edition was edited by: [GuillaumeGomez](https://github.com/GuillaumeGomez).
19 |
20 | # Latest news
21 |
22 | In the last team meeting, we decided that the [RFC "More api documentation conventions"](https://github.com/rust-lang/rfcs/pull/1574) was ready to get merged. We now wait for the core team confirmation.
23 |
24 | # Current opened issues
25 |
26 | For now, here are the two big issues for Rust documentation:
27 |
28 | * [The Standard Library Documentation Checklist](https://github.com/rust-lang/rust/issues/29329)
29 | * [Add error explanations for all error codes](https://github.com/rust-lang/rust/issues/32777)
30 |
31 | They both need help to move forward so any contribution is very welcome!
32 |
33 | There are currently around 50 other documentation issues opened. Look for [A-docs](https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AA-docs) tagged issues on github!
34 |
35 | # Call for participation
36 |
37 | There's now a call for participation to [display all methods of a type, even those from implicit traits in rustdoc](https://github.com/rust-lang/rust/issues/33772). This is a great way to help users find everything that a type can do. Any help on it would be very appreciated!
38 |
39 | # Waiting for merge
40 |
41 | * [@Manishearth](https://github.com/Manishearth) clarified [UnsafeCell docs](https://github.com/rust-lang/rust/pull/34520).
42 | * [@estebank](https://github.com/estebank) added [a specific error message for missplaced doc comments](https://github.com/rust-lang/rust/pull/33922).
43 | * [@GuillaumeGomez](https://github.com/GuillaumeGomez) added [libsyntax error code explanations](https://github.com/rust-lang/rust/pull/34637).
44 |
45 | # Recent doc contributions
46 |
47 | * [@alexandermerritt](https://github.com/alexandermerritt) made [docs for clone_from_slice consistent with copy_from_slice](https://github.com/rust-lang/rust/pull/34745).
48 | * [@ubsan](https://github.com/ubsan) added [more docs to std::mem::transmute](https://github.com/rust-lang/rust/pull/34609), fixed [ABI string docs in reference.md](https://github.com/rust-lang/rust/pull/34461) and fixed [ABI string docs in reference.md](https://github.com/rust-lang/rust/pull/34461).
49 | * [@rdotdk](https://github.com/rdotdk) updated [a cargo doc link](https://github.com/rust-lang/rust/pull/34615).
50 | * [@frewsxcv](https://github.com/frewsxcv) fixed [a broken markdown link in README](https://github.com/rust-lang/rust/pull/34619), improved [primitive integers documentation](https://github.com/rust-lang/rust/pull/34709), fixed [an unnecessarily mutable reference in doc example](https://github.com/rust-lang/rust/pull/34717) and added [doc examples for `io::Error::from_raw_os_error`](https://github.com/rust-lang/rust/pull/34612).
51 | * [@Xmasreturns](https://github.com/Xmasreturns) updated [glossary.md](https://github.com/rust-lang/rust/pull/34602).
52 | * [@jaredmanning](https://github.com/jaredmanning) fixed [spacing in for loop enumeration example](https://github.com/rust-lang/rust/pull/34625).
53 | * [@sylvestre](https://github.com/sylvestre) fixed [typos](https://github.com/rust-lang/rust/pull/34626).
54 | * [@durka](https://github.com/durka) documented [DoubleEndedIterator::next_back](https://github.com/rust-lang/rust/pull/34732).
55 | * [@GuillaumeGomez](https://github.com/GuillaumeGomez), added [examples for std::Error module](https://github.com/rust-lang/rust/pull/34750), improved [std::any module doc](https://github.com/rust-lang/rust/pull/34749), added [missing examples for std::cell types](https://github.com/rust-lang/rust/pull/34736), removed [an invalid CSS rule for doc titles](https://github.com/rust-lang/rust/pull/34685), improved [boxed docs](https://github.com/rust-lang/rust/pull/34740), improved [slice docs](https://github.com/rust-lang/rust/pull/34725). fixed [`std::path::Path::file_name()` doc](https://github.com/rust-lang/rust/pull/34659), removed [an useless doc comment for slice](https://github.com/rust-lang/rust/pull/34723) and improved [DoubleEndedIterator examples](https://github.com/rust-lang/rust/pull/34688).
56 | * [@llogiq](https://github.com/llogiq) improved the [internal documentation of HIR](https://github.com/rust-lang/rust/pull/34521)
57 |
58 | # Meetings
59 |
60 | Next meeting will be on Wednesday 13th of July 2016 at 20:00 GMT on #rust-docs channel on irc.mozilla.org. Feel free to come!
61 |
--------------------------------------------------------------------------------
/_posts/2016-7-18-this-week-in-rust-docs-13.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: post
3 | title: This Week in Rust Docs 13
4 | date: 2016-07-18
5 | ---
6 |
7 | Hello and welcome to *This Week in Rust Docs*!
8 |
9 | *This Week in Rust Docs* is openly developed [on GitHub](https://github.com/GuillaumeGomez/this-week-in-rust-docs).
10 | If you find any errors in this week's issue, [please submit a PR](https://github.com/GuillaumeGomez/this-week-in-rust-docs/pulls).
11 |
12 | And of course, don't forget to look at the docs:
13 |
14 | * [Stable](https://doc.rust-lang.org/)
15 | * [Beta](http://doc.rust-lang.org/beta/)
16 | * [Nightly](http://doc.rust-lang.org/nightly/)
17 |
18 | This week's edition was edited by: [GuillaumeGomez](https://github.com/GuillaumeGomez).
19 |
20 | # Latest news
21 |
22 | The ["More api documentation conventions" RFC](https://github.com/rust-lang/rfcs/pull/1574) has been merged!
23 |
24 | # Current opened issues
25 |
26 | For now, here are the two big issues for Rust documentation:
27 |
28 | * [The Standard Library Documentation Checklist](https://github.com/rust-lang/rust/issues/29329)
29 | * [Add error explanations for all error codes](https://github.com/rust-lang/rust/issues/32777)
30 |
31 | They both need help to move forward so any contribution is very welcome!
32 |
33 | There are currently around 50 other documentation issues opened. Look for [A-docs](https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AA-docs) tagged issues on github!
34 |
35 | # Call for participation
36 |
37 | There's now a call for participation to [display all methods of a type, even those from implicit traits in rustdoc](https://github.com/rust-lang/rust/issues/33772). This is a great way to help users find everything that a type can do. Any help on it would be very appreciated!
38 |
39 | # Waiting for merge
40 |
41 | * [@durka](https://github.com/durka) documented [DoubleEndedIterator::next_back](https://github.com/rust-lang/rust/pull/34732).
42 | * [@shepmaster](https://github.com/shepmaster) improved [{String,Vec}::from_raw_parts documentation](https://github.com/rust-lang/rust/pull/34884).
43 | * [@xitep](https://github.com/xitep) made [`.enumerate()` example self-explanatory](https://github.com/rust-lang/rust/pull/34880).
44 | * [@frewsxcv](https://github.com/frewsxcv) indicated [where `std::slice` structs originate from](https://github.com/rust-lang/rust/pull/34875) and partially [rewrote/expanded `Vec::truncate` documentation](https://github.com/rust-lang/rust/pull/34853).
45 | * [@Manishearth](https://github.com/Manishearth) clarified [UnsafeCell docs](https://github.com/rust-lang/rust/pull/34520).
46 | * [@estebank](https://github.com/estebank) added [a specific error message for missplaced doc comments](https://github.com/rust-lang/rust/pull/33922).
47 | * [@GuillaumeGomez](https://github.com/GuillaumeGomez) added [examples for VecDeque](https://github.com/rust-lang/rust/pull/34855) and added [examples for LinkedList](https://github.com/rust-lang/rust/pull/34854).
48 |
49 | # Recent doc contributions
50 |
51 | * [@ollie27](https://github.com/ollie27) fixed [methods in seach results in rustdoc](https://github.com/rust-lang/rust/pull/34752).
52 | * [@alexandermerritt](https://github.com/alexandermerritt) made [docs for `clone_from_slice` consistent with `copy_from_slice`](https://github.com/rust-lang/rust/pull/34745).
53 | * [@izgzhen](https://github.com/izgzhen) improved [arc doc](https://github.com/rust-lang/rust/pull/34733).
54 | * [@davidko](https://github.com/davidko) fixed [a few typos in The Book](https://github.com/rust-lang/rust/pull/34770).
55 | * [@glandium](https://github.com/glandium) added [a mention to the fact that writeln! and println! always use LF](https://github.com/rust-lang/rust/pull/34777).
56 | * [@wuranbo](https://github.com/wuranbo) fixed [ffi referenced rust-snappy which couldn't compile](https://github.com/rust-lang/rust/pull/34799).
57 | * [@frewsxcv](https://github.com/frewsxcv) added [where `std::vec` structs originate from](https://github.com/rust-lang/rust/pull/34818), made [various `std::process` doc](https://github.com/rust-lang/rust/pull/34737) and added [doc example for `std::process::ExitStatus::success`](https://github.com/rust-lang/rust/pull/34794).
58 | * [@steveklabnik](https://github.com/steveklabnik) fixed up [documentation around no_std](https://github.com/rust-lang/rust/pull/34838).
59 | * [@tshepang](https://github.com/tshepang) made a few doc [fixes](https://github.com/rust-lang/rust/pulls?utf8=%E2%9C%93&q=is%3Apr%20is%3Aclosed%2034849%2034848).
60 | * [@GuillaumeGomez](https://github.com/GuillaumeGomez) added [examples for FpCategory](https://github.com/rust-lang/rust/pull/34804) and added [libsyntax error code explanations](https://github.com/rust-lang/rust/pull/34637).
61 |
62 | # Meetings
63 |
64 | Next meeting will be on Wednesday 20th of July 2016 at 20:00 GMT on #rust-docs channel on irc.mozilla.org. Feel free to come!
65 |
--------------------------------------------------------------------------------
/_posts/2016-7-25-this-week-in-rust-docs-14.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: post
3 | title: This Week in Rust Docs 14
4 | date: 2016-07-25
5 | ---
6 |
7 | Hello and welcome to *This Week in Rust Docs*!
8 |
9 | *This Week in Rust Docs* is openly developed [on GitHub](https://github.com/GuillaumeGomez/this-week-in-rust-docs).
10 | If you find any errors in this week's issue, [please submit a PR](https://github.com/GuillaumeGomez/this-week-in-rust-docs/pulls).
11 |
12 | And of course, don't forget to look at the docs:
13 |
14 | * [Stable](https://doc.rust-lang.org/)
15 | * [Beta](http://doc.rust-lang.org/beta/)
16 | * [Nightly](http://doc.rust-lang.org/nightly/)
17 |
18 | This week's edition was edited by: [GuillaumeGomez](https://github.com/GuillaumeGomez).
19 |
20 | # Latest news
21 |
22 | A topic to propose crates for the Rust Doc Days has been created [here](https://users.rust-lang.org/t/call-for-proposals-for-next-rust-doc-days-crates/6685).
23 |
24 | # Current opened issues
25 |
26 | For now, here are the two big issues for Rust documentation:
27 |
28 | * [The Standard Library Documentation Checklist](https://github.com/rust-lang/rust/issues/29329)
29 | * [Add error explanations for all error codes](https://github.com/rust-lang/rust/issues/32777)
30 |
31 | They both need help to move forward so any contribution is very welcome!
32 |
33 | There are currently around 50 other documentation issues opened. Look for [A-docs](https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AA-docs) tagged issues on github!
34 |
35 | # Call for participation
36 |
37 | There's now a call for participation to [display all methods of a type, even those from implicit traits in rustdoc](https://github.com/rust-lang/rust/issues/33772). This is a great way to help users find everything that a type can do. Any help on it would be very appreciated!
38 |
39 | # Waiting for merge
40 |
41 | * [@qolop](https://github.com/qolop) fixed [typo (privledge->privilege)](https://github.com/rust-lang/rust/pull/34941).
42 | * [@jhod0](https://github.com/jhod0) added [diagnostics for rustc_metadata](https://github.com/rust-lang/rust/pull/34970).
43 | * [@abhijeetbhagat](https://github.com/abhijeetbhagat) updated [underscore usage](https://github.com/rust-lang/rust/pull/34990) and updated [VecDeque documentation to specify direction of index 0](https://github.com/rust-lang/rust/pull/34974).
44 | * [@rdwilliamson](https://github.com/rdwilliamson) fixed [HashMap's values_mut example to use println!](https://github.com/rust-lang/rust/pull/35001).
45 | * [@nrc](https://github.com/nrc) simplified [rustdoc URLs](https://github.com/rust-lang/rust/pull/35020).
46 | * [@durka](https://github.com/durka) documented [DoubleEndedIterator::next_back](https://github.com/rust-lang/rust/pull/34732).
47 | * [@Manishearth](https://github.com/Manishearth) clarified [UnsafeCell docs](https://github.com/rust-lang/rust/pull/34520).
48 | * [@estebank](https://github.com/estebank) added [a specific error message for missplaced doc comments](https://github.com/rust-lang/rust/pull/33922).
49 | * [@ollie27](https://github.com/ollie27) removed [item types from some title pages from rustdoc](https://github.com/rust-lang/rust/pull/35003).
50 | * [@frewsxcv](https://github.com/frewsxcv) rewrote/expanded [`slice::split` doc examples](https://github.com/rust-lang/rust/pull/35019).
51 | * [@GuillaumeGomez](https://github.com/GuillaumeGomez) fixed [formatting generation for rustdoc code examples](https://github.com/rust-lang/rust/pull/35012), improved [`DirEntry` doc](https://github.com/rust-lang/rust/pull/35009), added [DirBuilder doc examples](https://github.com/rust-lang/rust/pull/34995), added [HashMap Entry enums examples](https://github.com/rust-lang/rust/pull/34935) and improved [`Open` doc](https://github.com/rust-lang/rust/pull/35010).
52 |
53 | # Recent doc contributions
54 |
55 | * [@mark-buer](https://github.com/mark-buer) removed [rustdoc reference to `walk_dir`](https://github.com/rust-lang/rust/pull/34895).
56 | * [@wettowelreactor](https://github.com/wettowelreactor) fixed [some typos in char.rs](https://github.com/rust-lang/rust/pull/34977).
57 | * [@frewsxcv](https://github.com/frewsxcv) rewrote/expanded [doc examples for `Vec::set_len`](https://github.com/rust-lang/rust/pull/34911), improved [doc examples for `slice::windows`](https://github.com/rust-lang/rust/pull/34988), added [doc examples for `Vec::{as_slice,as_mut_slice}`](https://github.com/rust-lang/rust/pull/34930), indicated [where `std::slice` structs originate from](https://github.com/rust-lang/rust/pull/34875) and partially [rewrote/expanded `Vec::truncate` documentation](https://github.com/rust-lang/rust/pull/34853).
58 | * [@xitep](https://github.com/xitep) made [`.enumerate()` example self-explanatory](https://github.com/rust-lang/rust/pull/34880).
59 | * [@shepmaster](https://github.com/shepmaster) improved [{String,Vec}::from_raw_parts documentation](https://github.com/rust-lang/rust/pull/34884).
60 | [@GuillaumeGomez](https://github.com/GuillaumeGomez) fixed [Fix unwanted top margin for toggle wrapper in rustdoc CSS](https://github.com/rust-lang/rust/pull/34921), added [doc for btree_map types](https://github.com/rust-lang/rust/pull/34919), added [`BuildHasher` examples](https://github.com/rust-lang/rust/pull/34976), added [`RandomState` doc](https://github.com/rust-lang/rust/pull/34975), added [examples for VecDeque](https://github.com/rust-lang/rust/pull/34855) and added [examples for LinkedList](https://github.com/rust-lang/rust/pull/34854).
61 |
62 | # Meetings
63 |
64 | Next meeting will be on Wednesday 27th of July 2016 at 20:00 GMT on #rust-docs channel on irc.mozilla.org. Feel free to come!
65 |
--------------------------------------------------------------------------------
/_posts/2016-7-4-this-week-in-rust-docs-11.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: post
3 | title: This Week in Rust Docs 11
4 | date: 2016-07-04
5 | ---
6 |
7 | Hello and welcome to *This Week in Rust Docs*!
8 |
9 | *This Week in Rust Docs* is openly developed [on GitHub](https://github.com/GuillaumeGomez/this-week-in-rust-docs).
10 | If you find any errors in this week's issue, [please submit a PR](https://github.com/GuillaumeGomez/this-week-in-rust-docs/pulls).
11 |
12 | And of course, don't forget to look at the docs:
13 |
14 | * [Stable](https://doc.rust-lang.org/)
15 | * [Beta](http://doc.rust-lang.org/beta/)
16 | * [Nightly](http://doc.rust-lang.org/nightly/)
17 |
18 | This week's edition was edited by: [GuillaumeGomez](https://github.com/GuillaumeGomez).
19 |
20 | # Latest news
21 |
22 | In the last team meeting (renamed "schrodinger's doc meeting", thanks for the idea [@jonathandturner](https://github.com/jonathandturner)!), we mainly talked about The Rust Doc Days. The feedback is globally good but I'll let read the great [post](https://facility9.com/2016/07/rust-doc-days-follow-up/) that [@peschkaj](https://github.com/peschkaj) wrote about it.
23 |
24 | # Current opened issues
25 |
26 | For now, here are the two big issues for Rust documentation:
27 |
28 | * [The Standard Library Documentation Checklist](https://github.com/rust-lang/rust/issues/29329)
29 | * [Add error explanations for all error codes](https://github.com/rust-lang/rust/issues/32777)
30 |
31 | They both need help to move forward so any contribution is very welcome!
32 |
33 | There are currently around 50 other documentation issues opened. Look for [A-docs](https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AA-docs) tagged issues on github!
34 |
35 | # Call for participation
36 |
37 | There's now a call for participation to [display all methods of a type, even those from implicit traits in rustdoc](https://github.com/rust-lang/rust/issues/33772). This is a great way to help users find everything that a type can do. Any help on it would be very appreciated!
38 |
39 | # Waiting for merge
40 |
41 | * [@sylvestre](https://github.com/sylvestre) fixed [typos](https://github.com/rust-lang/rust/pull/34626).
42 | * [@jaredmanning](https://github.com/jaredmanning) fixed [spacing in for loop enumeration example](https://github.com/rust-lang/rust/pull/34625).
43 | * [@Xmasreturns](https://github.com/Xmasreturns) updated [glossary.md](https://github.com/rust-lang/rust/pull/34602).
44 | * [@frewsxcv](https://github.com/frewsxcv) fixed [broken markdown link in README](https://github.com/rust-lang/rust/pull/34619) and added [doc examples for `io::Error::from_raw_os_error`](https://github.com/rust-lang/rust/pull/34612).
45 | * [@rdotdk](https://github.com/rdotdk) updated [cargo doc link](https://github.com/rust-lang/rust/pull/34615).
46 | * [@Manishearth](https://github.com/Manishearth) clarified [UnsafeCell docs](https://github.com/rust-lang/rust/pull/34520).
47 | * [@ubsan](https://github.com/ubsan) added [more docs to std::mem::transmute](https://github.com/rust-lang/rust/pull/34609), fixed [ABI string docs in reference.md](https://github.com/rust-lang/rust/pull/34461) and fixed [ABI string docs in reference.md](https://github.com/rust-lang/rust/pull/34461).
48 | * [@estebank](https://github.com/estebank) added [specific error message for missplaced doc comments](https://github.com/rust-lang/rust/pull/33922).
49 | * [@GuillaumeGomez](https://github.com/GuillaumeGomez) added [libsyntax error codes explanation](https://github.com/rust-lang/rust/pull/34637).
50 |
51 | # Recent doc contributions
52 |
53 | * [@jupp0r](https://github.com/jupp0r) improved [code example for try!](https://github.com/rust-lang/rust/pull/34540).
54 | * [@jonmarkprice](https://github.com/jonmarkprice) made [small grammatical and stylistic edits to The Book](https://github.com/rust-lang/rust/pull/34532).
55 | * [@tatsuya6502](https://github.com/tatsuya6502) fixed [links in Ownership section of the book](https://github.com/rust-lang/rust/pull/34442).
56 | * [@dns2utf8](https://github.com/dns2utf8) added [example with leading zeros](https://github.com/rust-lang/rust/pull/34462).
57 | * [@frewsxcv](https://github.com/frewsxcv) expanded [`std::path::Component` documentation](https://github.com/rust-lang/rust/pull/34475), added [doc example for `std::io::sink`](https://github.com/rust-lang/rust/pull/34524), added [doc example for `std::io::repeat`](https://github.com/rust-lang/rust/pull/34518), made [a minor rewrite of `std::io::empty` doc example](https://github.com/rust-lang/rust/pull/34517) and added [example for `std::thread::sleep`](https://github.com/rust-lang/rust/pull/34406).
58 | * [@ollie27](https://github.com/ollie27) fixed [inlined renamed reexports in import lists](https://github.com/rust-lang/rust/pull/34479), fixed [a few stripping issues in rustdoc](https://github.com/rust-lang/rust/pull/34513), fixed [float examples](https://github.com/rust-lang/rust/pull/34415), fixed [search result layout for enum variants and struct fields](https://github.com/rust-lang/rust/pull/34477), fixed [empty Implementations section on some module pages in rustdoc](https://github.com/rust-lang/rust/pull/34536) and removed [Remove Derived Implementations title](https://github.com/rust-lang/rust/pull/34105).
59 | * [@GuillaumeGomez](https://github.com/GuillaumeGomez) fixed [E0269 explanation](https://github.com/rust-lang/rust/pull/34471), added [error codes in libsyntax](https://github.com/rust-lang/rust/pull/34531) and added [new error codes and improve some explanations](https://github.com/rust-lang/rust/pull/34467).
60 |
61 | # Meetings
62 |
63 | Next meeting will be on Wednesday 6th of July 2016 at 20:00 GMT on #rust-docs channel on irc.mozilla.org. Feel free to come!
64 |
--------------------------------------------------------------------------------
/_posts/2016-8-1-this-week-in-rust-docs-15.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: post
3 | title: This Week in Rust Docs 15
4 | date: 2016-08-01
5 | ---
6 |
7 | Hello and welcome to *This Week in Rust Docs*!
8 |
9 | *This Week in Rust Docs* is openly developed [on GitHub](https://github.com/GuillaumeGomez/this-week-in-rust-docs).
10 | If you find any errors in this week's issue, [please submit a PR](https://github.com/GuillaumeGomez/this-week-in-rust-docs/pulls).
11 |
12 | And of course, don't forget to look at the docs:
13 |
14 | * [Stable](https://doc.rust-lang.org/)
15 | * [Beta](http://doc.rust-lang.org/beta/)
16 | * [Nightly](http://doc.rust-lang.org/nightly/)
17 |
18 | This week's edition was edited by: [GuillaumeGomez](https://github.com/GuillaumeGomez).
19 |
20 | # Latest news
21 |
22 | A new RFC has been opened: [Add API documentation front page styleguide](https://github.com/rust-lang/rfcs/pull/1687).
23 |
24 | A topic to propose crates for the Rust Doc Days has been created [here](https://users.rust-lang.org/t/call-for-proposals-for-next-rust-doc-days-crates/6685). Please take a look!
25 |
26 | # Current opened issues
27 |
28 | For now, here are the two big issues for Rust documentation:
29 |
30 | * [The Standard Library Documentation Checklist](https://github.com/rust-lang/rust/issues/29329)
31 | * [Add error explanations for all error codes](https://github.com/rust-lang/rust/issues/32777)
32 |
33 | They both need help to move forward so any contribution is very welcome!
34 |
35 | There are currently around 50 other documentation issues opened. Look for [A-docs](https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AA-docs) tagged issues on github!
36 |
37 | # Call for participation
38 |
39 | There's now a call for participation to [display all methods of a type, even those from implicit traits in rustdoc](https://github.com/rust-lang/rust/issues/33772). This is a great way to help users find everything that a type can do. Any help on it would be very appreciated!
40 |
41 | # Waiting for merge
42 |
43 | * [@frewsxcv](https://github.com/frewsxcv) added [doc examples for `range::RangeArgument::{start,end}`](https://github.com/rust-lang/rust/pull/35041) and rewrote [`slice::chunks` doc example to not require printing](https://github.com/rust-lang/rust/pull/35134).
44 | * [@jongiddy](https://github.com/jongiddy) provide [a more explicit example of wildcard version in guessing game doc](https://github.com/rust-lang/rust/pull/35137).
45 | * [@qolop](https://github.com/qolop) fixed [typo (privledge->privilege)](https://github.com/rust-lang/rust/pull/34941).
46 | * [@jhod0](https://github.com/jhod0) added [diagnostics for rustc_metadata](https://github.com/rust-lang/rust/pull/34970).
47 | * [@nrc](https://github.com/nrc) simplified [rustdoc URLs](https://github.com/rust-lang/rust/pull/35020).
48 | * [@Manishearth](https://github.com/Manishearth) clarified [UnsafeCell docs](https://github.com/rust-lang/rust/pull/34520).
49 | * [@estebank](https://github.com/estebank) added [a specific error message for misplaced doc comments](https://github.com/rust-lang/rust/pull/33922).
50 | * [@ollie27](https://github.com/ollie27) removed [item types from some title pages from rustdoc](https://github.com/rust-lang/rust/pull/35003).
51 | * [@steveklabnik](https://github.com/steveklabnik) made it clear that [the reference isn't normative](https://github.com/rust-lang/rust/pull/35102).
52 | * [@GuillaumeGomez](https://github.com/GuillaumeGomez) added [doc examples for FileType struct](https://github.com/rust-lang/rust/pull/35076), added [`io::Error` doc examples](https://github.com/rust-lang/rust/pull/35109) and fixed [formatting generation for rustdoc code examples](https://github.com/rust-lang/rust/pull/35012).
53 |
54 | # Recent doc contributions
55 |
56 | * [@knight42](https://github.com/knight42) added [more intuitive explanation of strings formatting](https://github.com/rust-lang/rust/pull/35050).
57 | * [@munyari](https://github.com/munyari) added [docs for assert! and debug_assert!](https://github.com/rust-lang/rust/pull/35072).
58 | * [@vadimcn](https://github.com/vadimcn) fixed [typos](https://github.com/rust-lang/rust/pull/35066).
59 | * [@rdwilliamson](https://github.com/rdwilliamson) fixed [HashMap's values_mut example to use println!](https://github.com/rust-lang/rust/pull/35001).
60 | * [@abhijeetbhagat](https://github.com/abhijeetbhagat) updated [underscore usage](https://github.com/rust-lang/rust/pull/34990) and updated [VecDeque documentation to specify direction of index 0](https://github.com/rust-lang/rust/pull/34974).
61 | * [@durka](https://github.com/durka) documented [DoubleEndedIterator::next_back](https://github.com/rust-lang/rust/pull/34732).
62 | * [@frewsxcv](https://github.com/frewsxcv) rewrote/expanded [`slice::split` doc examples](https://github.com/rust-lang/rust/pull/35019).
63 | * [@frewsxcv](https://github.com/frewsxcv) rewrote [`collections::LinkedList::append` doc example](https://github.com/rust-lang/rust/pull/35104) and added [documentation example for `str::Chars::as_str`](https://github.com/rust-lang/rust/pull/35062).
64 | * [@GuillaumeGomez](https://github.com/GuillaumeGomez) added [`std::fs` docs](https://github.com/rust-lang/rust/pull/35087), improved [`DirEntry` doc](https://github.com/rust-lang/rust/pull/35009), added [HashMap Entry enums examples](https://github.com/rust-lang/rust/pull/34935), improved [`Open` doc](https://github.com/rust-lang/rust/pull/35010) and added [DirBuilder doc examples](https://github.com/rust-lang/rust/pull/34995).
65 |
66 | # Meetings
67 |
68 | Next meeting will be on Wednesday 3rd of August 2016 at 20:00 GMT on #rust-docs channel on irc.mozilla.org. Feel free to come!
69 |
--------------------------------------------------------------------------------
/_posts/2017-10-1-this-week-in-rust-docs-75.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: post
3 | title: This Week in Rust Docs 75
4 | date: 2017-10-1
5 | ---
6 |
7 | Hello and welcome to *This Week in Rust Docs*!
8 |
9 | *This Week in Rust Docs* is openly developed [on GitHub](https://github.com/GuillaumeGomez/this-week-in-rust-docs).
10 | If you find any errors in this week's issue, [please submit a PR](https://github.com/GuillaumeGomez/this-week-in-rust-docs/pulls).
11 |
12 | And of course, don't forget to look at the docs:
13 |
14 | * [Stable](https://doc.rust-lang.org/)
15 | * [Beta](https://doc.rust-lang.org/beta/)
16 | * [Nightly](https://doc.rust-lang.org/nightly/)
17 |
18 | This week's edition was edited by [Guillaume Gomez](https://github.com/GuillaumeGomez).
19 |
20 | # Latest news
21 |
22 | The switch to [Pulldown](https://github.com/google/pulldown-cmark) for the rust doc rendering has finally [started](https://github.com/rust-lang/rust/pull/41991)!
23 |
24 | # Current opened issues
25 |
26 | For now, here are the three big issues for Rust documentation:
27 |
28 | * [The Standard Library Documentation Checklist](https://github.com/rust-lang/rust/issues/29329)
29 | * [Add error explanations for all error codes](https://github.com/rust-lang/rust/issues/32777)
30 | * [Document all features in the Rust reference](https://github.com/rust-lang-nursery/reference/issues/9)
31 |
32 | They all need help to move forward so any contribution is very welcome!
33 |
34 | There are currently around 70 other documentation issues opened. Look for [T-doc](https://github.com/rust-lang/rust/labels/T-doc) tagged issues on GitHub!
35 |
36 | # Waiting for merge
37 |
38 | * [@QuietMisdreavus](https://github.com/QuietMisdreavus) made [rustdoc optimizations](https://github.com/rust-lang/rust/pull/44613) abd included [external files in documentation in rustdoc (RFC 1990)](https://github.com/rust-lang/rust/pull/44781).
39 | * [@steveklabnik](https://github.com/steveklabnik) deprecated [several flags in rustdoc](https://github.com/rust-lang/rust/pull/44138).
40 | * [@Aaronepower](https://github.com/Aaronepower) updated [RELEASES.md for 1.21.0](https://github.com/rust-lang/rust/pull/44481).
41 | * [@budziq](https://github.com/budziq) corrected [the CONTRIBUTING.md "External Dependencies" section](https://github.com/rust-lang/rust/pull/44664).
42 | * [@vi](https://github.com/vi) rendered [`[src]` links for trait implementors in rustdoc](https://github.com/rust-lang/rust/pull/44920).
43 | * [@Havvy](https://github.com/Havvy) improved [docs for size_of::<#[repr(C)]> items](https://github.com/rust-lang/rust/pull/44897).
44 | * [@leavehouse](https://github.com/leavehouse) fixed [TcpStream::local_addr docs example code](https://github.com/rust-lang/rust/pull/44913).
45 | * [@Pirh](https://github.com/Pirh) updated [docs for process::abort](https://github.com/rust-lang/rust/pull/44905).
46 | * [@kennytm](https://github.com/kennytm) improved [doc-test: in Markdown tests, Use all of `