This Week in Rust Docs 50

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 markdown renderer in rustdoc has been changed! We replaced hoedown with pulldown-cmark. Bugs might appear after this switch so any feedback is very welcomed! An issue has been opened here.

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

@estebank suggested using enum when a variant is used as a type, pointed to definition when modifying field of immutable variable, pointed at fields that make the type recursive and added an explicit help message for binop type mismatch.
@mandeep fixed typo in doc comments for swap_remove.
@frewsxcv made a couple minor improvements for tidy error handling.
@stjepang added a note about overflow for fetch_add/fetch_sub and improved some docs for VecDeque.
@irfanhudda improved option API docs and improved documentation of next_power_of_two.
@SimonSapin fixed link to current() in std::thread docs.
@pgerber improved documentation for std::fs::DirBuilder.
@sagebind improved examples for ThreadId.
@stepancheg improved BufRead::is_eof documentation.
@maccoda improved Convert docs.
@donniebishop added links to types in from_utf8 description and added links to from_utf8 methods in Utf8Error.
@Technius added links and some examples to std::sync::mpsc docs.
@mgattozzi updated Child docs to not have a note section and updated ChildStderr docs to be clearer.
@projektir updated the description for BarrierWaitResult.
@pirate added contribution instructions to stdlib docs.
@tschottdorf improved error when violating for<'a> T: 'a.
@GAJaloyan fixed mistakes in the README.md file.
@icefoxen made a tiny update to rustdoc CSS.
@GuillaumeGomez added ref suggestion, added support for image, rules and footnotes in the new rustdoc markdown renderer, fixed mutex’s docs inconsistency and added more explanation on RefCell::get_mut.

Recent doc contributions

@projektir added linking for Once docs, added links for Atomics docs and updated rustdoc to accept # at the start of a markdown file.
@donniebishop modified str structs descriptions, linked str in from_utf_unchecked, added a fromStr implementation example and linked ParseBoolError to from_str method of bool.
@frewsxcv synced all unstable features with Unstable Book; add tidy lint. and added all unstable features to Unstable Book..
@pirate added helpful hint in io docs about how ? is not allowed in main().
@topecongiro made overlapping_inherent_impls lint a hard error.
@MaloJaffre removed unused feature from error index generator and avoid linking to a moved page in rust.html.
@SamWhited improved the docs for the write and writeln macros.
@DaseinPhaos added missing link in unstable-book.
@rap2hpoutre addedexample to std::process::abort.
@wesleywiser made the rustdoc sidebar white on src pages.
@ctjhoa improved os::linux documentation.
@abonander memorized pub use-reexported macros so they don’t appear twice in docs.
@estebank clarified suggetion for field used as method.
@irfanhudda fixed typo in libcore/char.rs.
@steveklabnik updated various book modules.
@lukaramu improved std::net docs.
@stepancheg documented Cursor::new position is 0.
@TigleyM updated docs for std::str.
@ollie27 fixed broken Markdown and bad links in the error index and fixed compiler docs again.
@alanstoate changed string references in asciiext.
@Wallacoloo fixed typo in char::to_uppercase documentation.
@GuillaumeGomez replaced hoedown with pulldown in rustdoc, replaced hoedown with pull in rustdoc and added missing urls in ptr docs.

Meetings

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

Written on April 2, 2017