This Week in Rust Docs 68

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.
@ruuda pointed “deref coercions” links to new book.
@nrc fixed include! in doc tests.
@pengowen123 fixed unused_result lint triggering when a function returns (), ! or an empty enum.
@Eijebong fixed some typos.
@frewsxcv improved doc examples for include* macros..
@gaurikholkar added E0623 for structs.
@steveklabnik wrote the “passes” chapter of the rustdoc book.
@mattico added lint for int to ptr cast.
@qnighy added hints when intercrate ambiguity causes overlap..
@GuillaumeGomez added warnings when rustdoc html rendering differs, removed suggest methods in certain cases and added missing links doc.

Recent doc contributions

@RalfJung clarified wording for E0122.
@kennytm exposed all OS-specific modules in libstd doc and type-checked break value; even outside of loop {}.
@estebank pointed at return type always when type mismatch against it.
@Aaronepower updated release notes for 1.20.
@ruuda detected relative urls in tidy check.
@zackmdavis de-orphaned extended information, added #[must_use] for functions and made the e05XX odyssey.
@ollie27 removed external impls to implementors js in rustdoc, stopped using URL shortener in docs and fixed broken CSS in search results in rustdoc.
@lukaramu improved std::ops docs.
@tchajed updated GitHub pull request documentation link.
@steveklabnik added doc tests in rustdoc and documented the doc attribute.
@Eijebong fixed some typos.
@natboehm provided more explanation for Deref in String docs.
@j-browne fixed broken links in Arc documentation.
@prisme60 fixed typo corersponding -> corresponding.
@mattico fixed typo in unicode char definition.
@ubsan fixed a typo.
@pornel corrected the extern constant syntax in hint.
@ivanbakel fixed mutable vars being marked used when they weren’t.
@GuillaumeGomez removed warn on unused field on union, fixed rustdoc error on ‘\0’, added union and const colors, improved headers linking, improved file docs, improved enum variants display in rustdoc, improved error message when duplicate names for type and trait method and added missing error code for private method.

Meetings

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

Written on August 13, 2017