This Week in Rust Docs 62

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

After a long debate, it has been decided to keep hoedown testing/rendering by default in rustdoc. However, you can test pulldown by running rustdoc with -Z unstable-options enable-commonmark.

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

@oli-obk changed some notes into suggestions.
@Aaronepower updated releases notes for 1.19.
@frewsxcv fixed a couple broken links to the reference from error messages.
@rthomas updated docs on Error struct and updated docs for Debug* structs.
@cengizIO added pager support for rustc --explain EXXXX.
@Fourchaux fixed basic typos in Doc Comments.
@dns2utf8 added hint about the return code of panic!.
@Emilgardis fixed wrong report on closure args mismatch when a ref is expected but not found.
@Boreeas folded E0612, E0613 into E0609.
@estebank added rustc_on_unimplemented message to std::ops::Try and made suggestion include the line number.
@Mark-Simulacrum refactored pretty printing slightly and allowed setting the limit on std::io::Take.
@GuillaumeGomez added warnings when rustdoc html rendering differs, added errors when doc comments are added where they’re unused, cleaned up some code and fixed toggle wrappers not generated correctly in rustdoc.

Recent doc contributions

@pwoolcoc added allow_fail test attribute.
@ollie27 fixed a few issues with associated consts in rustdoc and fixed ICE on use *; in rustdoc.
@rthomas updated docs for fmt::write and updated docs for std::fmt::format.
@gaurikholkar added diagnostic code for lifetime errors with one named, one anonymous lifetime parameter.
@tbu- documented possible io::ErrorKinds of fs::open.
@matklad documented that / works as separator on Windows.
@estebank added missing ; detection on methods with return type ().
@AndiDog fixed compile-error.md link reference.
@casey reworded OsStr docs to clarify that utf8 may contain nulls.
@GuillaumeGomez created more error codes, removed err methods and added E0619 error explanation.

Meetings

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

Written on July 2, 2017