This Week in Rust Docs 77

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, included external files in documentation in rustdoc (RFC 1990) and showed in docs whether the return type of a function impls Iterator/Read/Write.
@steveklabnik deprecated several flags in rustdoc.
@estebank suggested syntax when finding method on array, warned when assigning a block that doesn’t have an implicit return and referred to types using the local identifier.
@sunjay documented the process for when rustfmt/rls break.
@jacwah mentionned Clone and refs in –explain E0382.
@Nemo157 rendered cfg(feature) requirements in documentation.
@goffrie provided the full span of method calls to check_argument_types.
@Havvy made a list of all lang items in unstable book.
@frewsxcv expanded docs/examples for TCP set_nonblocking methods.
@0xAX fixed a typo in src/bootstrap/README.md.
@SimonSapin fixed out of date unstable book entries for alloc_* features.
@GuillaumeGomez added short error message-format, improved sidebar rendering and added methods list, save selected search tab, saved the highlighted item when switching tab, removed terribly useless and problematic margin when searching on mobile, fixed arrow display, hid help when search bar is focused and limited the sidebar height.

Recent doc contributions

@QuietMisdreavus documented trait impls when the type appears in the trait’s generics and let rustdoc print the crate version into docs.
@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.
@shepmaster don’t encourage people to ignore threading errors in the docs.
@oli-obk upgraded some comments to doc comments.
@petrochenkov fixed a mistake in release notes for 1.21.0.
@sinkuu made a better error message for missing tuple pattern in args.
@stjepang increased padding between consecutive impls in rustdoc.
@Gankro clarified how needs_drop is conservative.
@laumann added suggestions for misspelled labels.
@Badel2 made a better error message for comma after base struct.
@jean-lourenco improved compile error output when using arguments instead of types.
@johnthagen fixed typos and clarified RAM usage during build in README.
@tinaun documented a few more unstable feature gates.
@camsteffen fixed rustc documentation typo.
@rkruppe fixed typo in codegen test.
@GuillaumeGomez added tabs for search for better information access, usize index message for vec and made improvements in the mobile sidebar.

Meetings

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

Written on October 15, 2017