This Week in Rust Docs 69

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 rewrite of rustdoc is still under heavy development. Don’t hesitate to give it a try!

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

@oli-obk added lint casting signed integers smaller than isize to raw pointers and improved placement of use suggestions.
@ruuda pointed “deref coercions” links to new book.
@gaurikholkar added E0623 for structs and improved error message for one named, one anonymous lifetime parameters - underline Type.
@qnighy added hints when intercrate ambiguity causes overlap.
@shanavas786 fixed typo in doc.
@huntiep improved Try error messages.
@estebank pointed out missing if conditional.
@QuietMisdreavus added new “Implementations on Foreign Types” section to traits in rustdoc.
@GuillaumeGomez added warnings when rustdoc html rendering differs, added missing links in docs, removed outline when details have focus, compile fail stable, removed duplicates in rustdoc and added deref suggestion.

Recent doc contributions

@nrc fixed include! in doc tests and uplifted fix for include! in doc tests to beta.
@Eijebong fixed some typos.
@frewsxcv improved doc examples for include* macros, made a minor Iterator::filter_map description rewording, made a minor rewrite of char primitive unicode intro, clarified writable behavior of readonly-named Permissions methods and rewrote/reorganized docs for stack size/thread names for spawned threads.
@steveklabnik wrote the “passes” chapter of the rustdoc book, updated the books for next release and shipped the rustdoc book.
@topecongiro fixed bad span for attributes.
@anthonyclays fixed typo in RefCell::get_mut.
@Songbird0 improved E0106 - field lifetimes.
@adrian5 fixed typo in doc.
@partim documented that std::hash::Hasher::finish() does not reset the hasher.
@Fourchaux fixed typos & us spellings.
@QuietMisdreavus put auto-hidden docblock labels in line with the toggle in rustdoc.
@lukaramu added missing newline in Deref docs to fix rendering.
@ollie27 removed external impls to implementors js in rustdoc.
@GuillaumeGomez added missing links doc, udpdated error message for unsized union field, added help for static method invalid use, removed useless help part and added a note to unused variables.

Meetings

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

Written on August 20, 2017