This Week in Rust Docs 44

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 rustdoc --test output has been updated and merged! Now it looks like this:

> rustdoc --test some_file.rs
the/path/some_file.rs - Foo::foo (line 43) ... ok
the/path/some_file.rs - Foo::bar (line 79) ... ok

Please take a look to the next rust doc days planning reminder.

The topic to propose crates for the Rust Doc Days is still open and waiting for contributions here. Please take a look!

Current opened issues

For now, here are the two 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 A-docs tagged issues on GitHub!

Waiting for merge

@mp4096 wrote better explanation for return values for min, max functions for the Iterator trait.
@keeperofdakeys provided suggestions for unknown macros imported with use and added notes about capacity effects to Vec::truncate().
@steveklabnik ported the reference to mdbook and create the Unstable Book.
@arthurprs fix spelling in hashmap comments.
@JDemler added Documentation for Custom Attributes and Error Reporting in Procedural Macros.
@jrmuizel removed obsolete documentation about drop-flags.
@mina86 updated The Book: binary prefixed are defined by IEC and not in SI.
@Dowwie updated attributes.md - Last sentence updated to reflect support for custom attributes.
@GuillaumeGomez improved associated constant rendering in rustdoc, set rustdoc –test files’ path relative to the current directory, improved file not found for module error, fixed invalid module suggestion and improved invalid call on non-function error message.

Recent doc contributions

@shepmaster improved grammar on field init docs and removed duplicated “parameter” in E0089 text.
@JordiPolo substituted try! for ? in the Result documentation.
@jimmycuadra included a stability span only if needed in rustdoc.
@notriddle added the item type to the tooltip.
@ollie27 showed attributes on all item types in rustdoc.
@stjepang fixed wording in LocalKey documentation.
@king6cong updated sys/mod doc and mod import order adjust, made doc consistent with var name and fixed a typo.
@Stebalien fixed String::split_off documentation.
@CBenoit corrected a typo in procedural macros chapter of the Book.
@WRONGWAY4YOU fixed typo.
@durka fixed types in to_owned doctest.
@DaseinPhaos updated procedural-macros.md.
@mina86 removed GNU extensions in the example when they were unnecessary in The Book.
@steveklabnik ported books to mdbook.
@ahmedcharles fixed some typos in the core::fmt docs..
@GuillaumeGomez added tested item in the rustdoc –test output, added missing urls for env functions and added filename when running rustdoc –test on a markdown file.

Meetings

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

Written on February 19, 2017