This Week in Rust Docs 61

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.
@pwoolcoc added allow_fail test attribute.
@Aaronepower updated releases notes for 1.19.
@ollie27 fixed a few issues with associated consts in rustdoc and fixed ICE on use *; in rustdoc.
@frewsxcv fixed a couple broken links to the reference from error messages.
@rthomas updated docs for fmt::write, updated docs on Error struct, updated docs for Debug* structs and updated docs for std::fmt::format.
@cengizIO added pager support for rustc --explain EXXXX.
@Fourchaux fixed basic typos in Doc Comments.
@nagisa fix NaN handling in is_sign_negative/positive and specialisation of Iterator methods for Range.
@gaurikholkar adding diagnostic code for lifetime errors with one named, one anonymous lifetime parameter.
@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.
@GuillaumeGomez added warnings when rustdoc html rendering differs, created more error codes and remove err methods.

Recent doc contributions

@alex-ozdemir made clearer error message for Duplicate Definition.
@Mark-Simulacrum printed the two types in the span label for transmute errors and made rustc errors colorful.
@ollie27 used create_dir_all to create output directory in rustdoc, fixed compiler docs yet again, and linked directly to associated types in rustdoc.
@maccoda completed env docs.
@birkenfeld added dedicated docstrings to Sum/Product impl of Result and simplified FromIterator example of Result.
@ucarion explicated what “Rc” and “Arc” stand for.
@cramertj changed span label for E0435.
@letheed fixed ref as mutable ref in std::rc::Rc doc.
@zackmdavis added extended information for E0562; impl Trait can only be a return type.
@kennytm removed most “```ignore” doc tests..
@frewsxcv made additions/improvements for doc examples.
@wesleywiser added compile_error!.
@est31 removed SUMMARY.md of the unstable book as its autogenerated and introduced tidy lint to check for inconsistent tracking issues.
@GuillaumeGomez added E0609, added 0608, new error codes and error codes new.

Meetings

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

Written on June 25, 2017