This Week in Rust Docs 72

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 switch to Pulldown for the rust doc rendering has finally started!

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

@QuietMisdreavus hid internal types/traits from std docs via new #[doc(masked)] attribute.
@gaurikholkar extended E0623 for LateBound and EarlyBound Regions and added E0623 for return types - both parameters are anonymous.
@steveklabnik deprecated several flags in rustdoc and updated mdbook.
@tommyip added doc example to String::as_mut_str and added doc example to String::as_str.
@smt923 added short doc examples for str::from_utf8_mut.
@toidiu updated documentation to demonstrate mutability.
@napen123 added doc examples for str::as_bytes_mut.
@frehberg extended UdpSocket API doc.
@est31 moved the man directory to a subdirectory.
@joshlf documented std::thread::LocalKey limitation with initializers.
@laumann added suggestions for misspelled method names.
@GuillaumeGomez stabilised compile_fail, added deref suggestion, fixed rendering of const keyword for functions, added display of cfg in rustdoc, codeblock color, reduced false positives number in rustdoc html diff and removed small id false positive in rustdoc html diff.

Recent doc contributions

@qnighy added hints when intercrate ambiguity causes overlap.
@QuietMisdreavus added new “Implementations on Foreign Types” section to traits in rustdoc and expanded on using rustup custom toolchains in CONTRIBUTING.md.
@Mark-Simulacrum added rustdoc tests.
@MarkMcCaskey updated unimplemented! docs.
@kennytm removed invalid doctest from bootstrap.py.
@WiSaGaN fixed link typo in 1.20.0 release notes.
@jakllsch included docs in extended distribution only if enabled.
@lu-zero removed the incorrect documentation for from_str.
@RalfJung removed dead test functions from rustbook.
@kallisti5 gave an example to get UNIX_EPOCH in seconds in std::time.

Meetings

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

Written on September 10, 2017