This Week in Rust Docs 45
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
Nothing.
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
- @brson added release notes for 1.16.
- @pmer used “macOS” terminology consistently.
- @SimonSapin published docs for the proc_macro crate.
- @keeperofdakeys replaced ./configure with config.toml in README.md and CONTRIBUTING.md and added notes about capacity effects to Vec::truncate().
- @oli-obk distinguished guesses from suggestions.
- @zackmdavis used help rather than span note for no method error; a slight rephrasing.
- @estebank highlighted code in
rustc --explain
. - @GuillaumeGomez fixed nightly-only experimental API display, added missing url in sync structs, added missing urls and small nits, improved invalid call on non-function error message, fixed invalid module suggestion, added missing urls and examples for Condvar docs, added ref suggestion and improved associated constant rendering in rustdoc.
Recent doc contributions
- @mp4096 wrote better explanation for return values for min, max functions for the Iterator trait.
- @keeperofdakeys provided suggestions for unknown macros imported with
use
. - @steveklabnik ported the reference to mdbook, created the Unstable Book, reenabled the linkchecker for books and updated mdbook version.
- @arthurprs fixed 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.
- @tclfs fixed a typo.
- @cynicaldevil added test for inclusive_range_syntax in compile-fail test suite.
- @Rufflewind added Gankro’s table to nomicon/src/phantom-data.md and resolved ambiguities of Generics in The Book.
- @danobi moved COMPILER_TESTS.md out of the root directory.
- @estebank displayed properly note/expected details.
- @sgrif fixed indentation of error message.
- @tomwhoiscontrary corrected another typo in procedural macros chapter of the Book.
- @mbrubeck added additional docs for Vec, String, and slice trait impls.
- @ArtBears fixed a typo in CONTRIBUTING.md.
- @GuillaumeGomez set rustdoc –test files’ path relative to the current directory, improved file not found for module error, added missing urls and examples into Barrier structs and added missing urls in MutexGuard docs.
Meetings
Next meeting will be on Wednesday 1st of March 2017 at 20:00 GMT on #rust-docs channel on irc.mozilla.org. Feel free to come!
Written on February 26, 2017