This Week in Rust Docs 74

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:

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

@QuietMisdreavus made rustdoc optimizations and included external files in documentation in rustdoc (RFC 1990).
@gaurikholkar added E0623 for return types - both parameters are anonymous.
@steveklabnik deprecated several flags in rustdoc.
@laumann added suggestions for misspelled method names.
@zackmdavis added comparison operators to must-use lint (under fn_must_use feature) and prevented rustdoc to get confused by text “fn main” in a line comment.
@frewsxcv indicated how ChildStd{in,out,err} FDs are closed.
@Aaronepower updated RELEASES.md for 1.21.0.
@thombles improved diagnostics when attempting to match tuple enum variant with struct pattern.
@napen123 added doc example to HashMap::hasher.
@lucasem made docs improvement in std::sync::{PoisonError, TryLockError}.
@tirr-c made a friendlier error message for closure argument type mismatch.
@estebank pointed [at parameter type on E0301](https://github.com/rust-lang/rust/pull/44782].
@budziq corrected the CONTRIBUTING.md “External Dependencies” section.
@GuillaumeGomez added short error message-format and fixed warning position in rustdoc code blocks.

Recent doc contributions

@QuietMisdreavus hid internal types/traits from std docs via new #[doc(masked)] attribute.
@gaurikholkar extended E0623 for earlybound and latebound for structs.
@bluss documented thread builder panics for nul bytes in thread names.
@oli-obk removed suggestion of placing use statements into expanded code.
@Havvy expanded size_of docs.
@frewsxcv fixed incorrect into_inner link in docs.
@nikomatsakis reworked the README.md for rustc and add other readmes.
@lucasem improved std::sync::RwLock docs.
@spastorino linked to Rust forge from CONTRIBUTING.md.
@durka improved english in create_dir_all docs.
@mattico fixed librustc/README.md diagram.
@oconnor663 fixed an incorrect assertion in the doc example for std::io::copy.
@mssun fixed a typo in rustc help menu.
@GuillaumeGomez added deref suggestion, updated codeblock color, removed small id false positive in rustdoc html diff, added pub visibility for methods as well, added missing links for Arc, added some missing links in io docs, fixed run button and added more links and put the link character to the left.

Meetings

Next meeting will be on Wednesday 27th of September 2017 at 20:00 GMT on #rust-docs channel on irc.mozilla.org. Feel free to come!

Written on September 24, 2017