This Week in Rust Docs 82

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 included external files in documentation in rustdoc (RFC 1990) and showed in docs whether the return type of a function impls Iterator/Read/Write.
@Aaronepower updated Release notes for 1.22.0.
@estebank highlighted code on diagnostics when underlined, accounted for missing keyword in fn/struct definition, used the proper term when using non-existing variant, used multiline text for crate conflict diagnostics, displayed \t in diagnostics code as four spaces, highlighted code on diagnostics when underlined and removed dereference suggestion on tuple argument.
@fhartwig made rustdoc not include self-by-value methods from Deref target.
@JRegimbal changed “Types/modules” title of search tab to be more accurate.
@oli-obk added structured suggestions for various “use” suggestions and included rendered diagnostic in json.
@sinkuu added doc for doing Read from &str.
@kennytm combined “this expression will panic at run-time” warnings into const_err lint.
@ollie27 fixed broken CSS for book redirect pages.
@GuillaumeGomez fixed path search.

Recent doc contributions

@QuietMisdreavus added talk about #![doc(test(no_crate_inject))] and #![doc(test(attr(…)))] in rustdoc, tweaked notes on ignore/compile_fail examples in rustdoc and updated examples: in Cow::into_owned don’t need to wrap result in Cows.
@steveklabnik started shipping the Cargo book.
@pornel removed deprecated message.
@oli-obk removed left over dead code from suggestion diagnostic refactoring.
@kennytm fixed several pulldown warnings when documenting libstd.
@lnicola escaped doc root URLs in rustdoc.
@ExpHP added context to E0084, E0517, E0518.
@zackmdavis deduplicated projection error (E0271) messages.
@GuillaumeGomez added search over generic types in docs, fixed primitive types not showing up, set short-message feature unstable and added missing links in FromStr docs.

Meetings

Next meeting will be on Tuesday 21st of November 2017 at 19:00 UTC on #rust-docs channel on irc.mozilla.org. Feel free to come!

Written on November 19, 2017