This Week in Rust Docs 58

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

@gamazeps expanded detach documentation in thread::JoinHande.
@Aaronepower updated releases notes for 1.18.
@kennytm introduced ‘ui-run’ test to compiletest.
@mjkillough documented direct implementations on type aliases..
@oli-obk changed some notes into suggestions.
@alex-ozdemir made clearer error message for Duplicate Definition.
@irfanhudda improved documentation of next_power_of_two.
@clarcharr clarified docs on implementing Into.
@pwoolcoc added allow_fail test attribute.
@tommyip explained why a closure is FnOnce in closure errors.
@stjepang unified the docs of PartialEq, PartialOrd and Ord and clarified the docs for align_of and its variants.
@GuillaumeGomez added warnings when rustdoc html rendering differs, updated rustdoc man page and added new error codes.

Recent doc contributions

@gamazeps added 'static and Send constraints explanations to thread::spawn.
@neosilky updated to trait bounds CSS in rustdoc.
@frewsxcv added a few entries to the Unstable Book..
@euclio removed “much” from unicode diagnostic.
@nical updated to Rc and Arc documentation to favor the Rc::clone(&ptr) syntax.
@citizen428 updated documentation for indexing/slicing methods and changed error count messages.
@king6cong reworded doc.
@charliesome fixed ‘associate type’ typo.
@Havvy documented drop more.
@SamWhited fixed broken link to nomicon in Unsize docs.
@projektir added links to option::Option.
@ollie27 fixed names of items in cross crate reexported modules in rustdoc.
@Wallacoloo mentionned Vec::into_boxed_slice in documentation of [T]::into_vec.
@GuillaumeGomez added better error message when == operator is badly used, made –extend-css stable, added missing urls for OsStr docs and added missing links for CStr and CString.

Meetings

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

Written on May 28, 2017