This Week in Rust Docs 57

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

@F001 fixed comma after struct update syntax.
@gamazeps added 'static and Send constraints explanations to thread::spawn and expanded detach documentation in thread::JoinHande.
@Aaronepower updated releases notes for 1.18.
@neosilky updated to trait bounds CSS in rustdoc.
@kennytm introduced ‘ui-run’ test to compiletest.
@mjkillough documented direct implementations on type aliases..
@oli-obk changed some notes into suggestions.
@frewsxcv added a few entries to the Unstable Book..
@euclio removed “much” from unicode diagnostic.
@alex-ozdemir made clearer error message for Duplicate Definition.
@Idolf supported #![deny(missing_docs)] together with #[proc_macro_derive].
@GuillaumeGomez added better error message when == operator is badly used, made –extend-css stable and added warnings when rustdoc html rendering differs.

Recent doc contributions

@estebank made unsatisfied trait bounds note multiline.
@abonander documented the proc_macro feature in the Unstable Book.
@est31 added lint for unused macros.
@gamazeps explained why thread::yield_now could be used, improved thread::Builder’s doc and added links to the thread::LocalKey doc.
@dhardy added 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.
@cuviper gave a nicer error for non-Unicode arguments to rustc and rustdoc.
@maccoda improved std::env docs.
@ollie27 fixed implementors list in Rustdoc’s javascript, corrected some stability versions and displayed extern "C" fn instead of extern fn in rustdoc.
@citizen428 added documentation for ExitStatus.
@seeekr fixed typo in libstd/sync/mpsc/mod.rs docs.
@pravic fixed regression introduced by jQuery removal.
@tshepang improved std::env docs.
@faso fixed a typo in contributing.md.
@rap2hpoutre improved collapse toggle render (css).
@GuillaumeGomez added help message if a FnOnce is moved.

Meetings

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

Written on May 21, 2017