This Week in Rust Docs 73

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 switch to Pulldown for the rust doc rendering has finally started!

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

@QuietMisdreavus hid internal types/traits from std docs via new #[doc(masked)] attribute and made rustdoc optimizations.
@gaurikholkar added E0623 for return types - both parameters are anonymous and extended E0623 for earlybound and latebound for structs.
@steveklabnik deprecated several flags in rustdoc.
@laumann added suggestions for misspelled method names.
@zackmdavis added comparison operators to must-use lint (under fn_must_use feature).
@bluss documented thread builder panics for nul bytes in thread names.
@oli-obk removed suggestion of placing use statements into expanded code.
@Havvy expanded size_of docs.
@frewsxcv indicated how ChildStd{in,out,err} FDs are closed and fixed incorrect into_inner link in docs.
@eddyb pretty-printed unevaluated expressions in types.
@nikomatsakis reworked the README.md for rustc and add other readmes.
@Aaronepower updated RELEASES.md for 1.21.0.
@GuillaumeGomez added deref suggestion, added display of cfg in rustdoc, updated codeblock color, removed small id false positive in rustdoc html diff, added short error message-format and added pub visibility for methods as well.

Recent doc contributions

@gaurikholkar extended E0623 for LateBound and EarlyBound Regions and extended E0623 for fn items.
@steveklabnik updated mdbook.
@tommyip added doc example to String::as_mut_str, added doc example to String::as_str and added doc example to str::from_boxed_utf8_unchecked.
@smt923 added short doc examples for str::from_utf8_mut.
@toidiu updated documentation to demonstrate mutability.
@napen123 added doc examples for str::as_bytes_mut and added doc examples to str::from_utf8_unchecked_mut.
@frehberg extended UdpSocket API doc.
@est31 moved the man directory to a subdirectory, used “avoid” instead of “disable” because it’s a better word there and fixed mispositioned error indicators.
@joshlf documented std::thread::LocalKey limitation with initializers.
@jonhoo mentionned that HashMap::new and HashSet::new do not allocate.
@ollie27 removed double count of ids when using –enable-commonmark.
@rwakulszowa added an example of std::str::encode_utf16.
@frewsxcv clarified return type of String::from_utf16_lossy.
@adlerd fixed drain_filter doctest.
@Havvy fixed example in transmute.
@42triangles added an example for std::str::into_boxed_bytes().
@carols10cents updated label explanations.
@tbu- clarified the behavior of UDP sockets wrt. multiple addresses in connect.
@GuillaumeGomez stabilised compile_fail, fixed rendering of const keyword for functions, reduced false positives number in rustdoc html diff and updated openoptions docs.

Meetings

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

Written on September 17, 2017