This Week in Rust Docs 23

Posted on September 25, 2016 by This week in Rust Docs

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 “new” run button has been merged and is now used in nightly docs. Give it a try!

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 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 A-docs tagged issues on GitHub!

Call for participation

There’s now a call for participation to display all methods of a type, even those from implicit traits in rustdoc. This is a great way to help users find everything that a type can do. Any help on it would be very appreciated!

Waiting for merge

@bluss updated rustdoc’s CSS to put where in trait listings on a new line.
@QuietMisdreavus updated rustdoc to print non-self arguments of bare functions and struct methods on their own line.
@pmatos improved documention troubleshooting missing linker.
@kmcallister updated Arc docs to match new Rc docs.
@japaric implemented –sysroot on rustdoc.
@liigo updated rustdoc to inline sidebar items, to display more in a page.
@giannicic fixed E0520 error message.
@sinkuu made E0243/E0244 message consistent with E0107.
@vanjacosic updated the “Ownership” section of The Book and updated the “Getting started” section of The Book.
@christopherdumas updated includes! documentation.
@EdorianDark inserted examples with universal function call syntax.
@matthew-piziak added links to interesting items in std::ptr documentation, refactored range examples and added default docstrings for String, AtomicBool, and Generics.
@steveklabnik made it clear that reference isn’t normative.
@GuillaumeGomez updated doc comments to new macro url syntax, fixed run button appearing when it shouldn’t, fixed some typos and improve doc comments style, added missing urls for Box doc, added information in case of markdown block code test failure and fixed formatting generation for rustdoc code examples.

Recent doc contributions

@kmcallister tweaked std::rc docs.
@caipre made a minor correction in sort_by_key doc comment.
@Mark-Simulacrum fixed language in documentation comment, added example in AsMut trait documentation and added links between format_args! macro and std::fmt::Arguments struct](https://github.com/rust-lang/rust/pull/36523).
@frewsxcv added basic doc examples for std::panic::{set_hook, take_hook} and made a minor VecDeque doc examples cleanup.
@GuillaumeGomez proposed a global rust-lang.org architecture change, replaced ‘e.g.’ by ‘i.e.’ and added metadata diagnostics.

Meetings

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