This Week in Rust Docs 56

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

@estebank made unsatisfied trait bounds note multiline.
@icefoxen made a tiny update to rustdoc CSS.
@abonander documented the proc_macro feature in the Unstable Book.
@F001 updated backtrace formating text tips and fixed comma after struct update syntax.
@est31 added lint for unused macros.
@gamazeps added 'static and Send constraints explanations to thread::spawn, expanded detach documentation in thread::JoinHande and explained why thread::yield_now could be used.
@Aaronepower updated releases notes for 1.18.
@kosta improved error message ‘can’t qualify macro invocation with ‘.
@dhardy add loop_break_value documentation for The Book.
@excaliburHisSheath improved docs in os::windows::ffi and os::windows::fs.
@froydnj fixed confusion about parts required for float formatting.
@GuillaumeGomez reduced HTML output in rustdoc, added better error message when == operator is badly used, added help message if a FnOnce is moved and made –extend-css stable.

Recent doc contributions

@estebank pointed at fields that make the type recursive and used diagnostics for trace_macro instead of println.
@mandeep added generic example of std::ops::Add in doc comments.
@brson updated release notes for 1.17.
@steveklabnik improved docs on Arc<T> and Send/Sync and added more ways to create a PathBuf to docs.
@Mark-Simulacrum allowed # to appear in rustdoc code output and made a minor cleanup of UX guidelines.
@oli-obk refactored suggestion diagnostic API to allow for multiple suggestions and upgraded some comments to doc comments.
@gamazeps improved thread::panicking documentation, improved thread::Thread and thread::Builder documentations, improved thread::spawn documentation and improved the thread::park and thread::unpark documentation.
@mglagla fixed typo in Iterator::size_hint example comment.
@Eijebong broke words in the location box of the sidebar in rustdoc.
@mbrubeck removed wrong or outdated info from CString docs..
@RalfJung fixed typo in Unique::empty doc.
@Migi fixed typo in subst.rs.
@z1mvader fixed argument inference for closures when coercing into ‘fn’.
@jz0425 updated rustc-ux-guidelines.

@GuillaumeGomez fixed anchor invalid redirection to search, added [markdown-before

after-content options](https://github.com/rust-lang/rust/pull/41826), fixed search when looking to sources and improved E0477 error message.

Meetings

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

Written on May 14, 2017