This Week in Rust Docs 75

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 abd included external files in documentation in rustdoc (RFC 1990).
@steveklabnik deprecated several flags in rustdoc.
@Aaronepower updated RELEASES.md for 1.21.0.
@budziq corrected the CONTRIBUTING.md “External Dependencies” section.
@vi rendered [src] links for trait implementors in rustdoc.
@Havvy improved docs for size_of::<#[repr(C)]> items.
@leavehouse fixed TcpStream::local_addr docs example code.
@Pirh updated docs for process::abort.
@kennytm improved doc-test: in Markdown tests, Use all of <h1> to <h6> as the test name.
@federicomenaquintero improved docs for CStr, CString, OsStr, OsString.
@GuillaumeGomez added short error message-format and added missing fnty args rustdoc.

Recent doc contributions

@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.
@thombles improved diagnostics when attempting to match tuple enum variant with struct pattern.
@tirr-c made a friendlier error message for closure argument type mismatch.
@estebank pointed at parameter type on E0301, pointed at signature on unused lint anded point at parameter type on E0301.
@dbrgn added trace_macros! to unstable book.
@pnkfelix some fixes to mir-borrowck.
@GuillaumeGomez fixed warning position in rustdoc code blocks.

Meetings

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

Written on October 1, 2017