This Week in Rust Docs 24

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

@frewsxcv made a “minor” librustdoc cleanup and refactoring.
@BlueSpaceCanary removed the double introduction for cargo run.
@gavinb improved error message and snippet for “did you mean x”.
@green-coder updated example code in the documentation.
@QuietMisdreavus updated rustdoc to print non-self arguments of bare functions and struct methods on their own line.
@kmcallister updated Arc docs to match new Rc docs.
@liigo updated rustdoc to inline sidebar items, to display more in a page.
@sinkuu made E0243/E0244 message consistent with E0107.
@christopherdumas updated includes! documentation.
@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 fixed run button appearing when it shouldn’t, added information in case of markdown block code test failure and fixed formatting generation for rustdoc code examples.

Recent doc contributions

@alygin updated E0512 to new error format.
@KiChjang updated E0025 to new error format.
@nathanmusoke fixed minor typo in variable bindings in The Book.
@palango added link to format! docs.
@wesleywiser made Send and Sync traits to the reference.
@tmiasko fixed BufRead::read_until documentation and reworded description of SystemTimeError.
@frewsxcv made a couple refactorings in librustdoc and added basic doc example for core::ptr::write_bytes.
@bluss updated rustdoc’s CSS to put where in trait listings on a new line.
@japaric implemented –sysroot on rustdoc.
@giannicic fixed E0520 error message.
@pmatos improved documention troubleshooting missing linker.
@vanjacosic updated the “Ownership” section of The Book and updated the “Getting started” section of The Book.
@jonathandturner updated E0425, E0446 and E0449.
@GuillaumeGomez updated doc comments to new macro url syntax, added E0513 stuff, updated E0035, E0036 and E0370 to new error format, improved process module doc a bit, added missing urls for ops module, added missing links on cmp module, fixed some typos and improve doc comments style and added missing urls for Box doc.

Meetings

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

Written on October 2, 2016