This Week in Rust Docs 106

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

Some improvements on JS size are being worked on. More to come soon!

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

@Phlosioneer clarified the difference between get_mut and into_mut for OccupiedEntry.
@mulkieran made some documentation fixes for the Write trait.
@fkjogu documented round-off error in .mod_euc()-method.
@petrochenkov added deprecation lint for duplicated macro_exports.
@F001 added lint for multiple associated types.
@frewsxcv provided more context for what the {f32,f64}::EPSILON values represent.
@davidtwco added rustdoc documentation to compiler docs.
@mandeep added doc comment to hiding portions of code example.
@simartin improved error diagnostic with missing commas after struct fields.
@d-e-s-o fixed typo in cell.rs.
@QuietMisdreavus used “short form” doc(cfg) printing even when combined with other conditionals in rustdoc.
@GuillaumeGomez stabilized short error format, fixed extern prelude failure in rustdoc and added E0665.

Recent doc contributions

@ecstatic-morse rewrote docs for std::ptr.
@QuietMisdreavus deprecated #![doc(passes, plugins, no_default_passes)] in rustdoc and replaced most (e)println! statements with structured warnings/errors in rustdoc.
@ollie27 added support for pub(restricted) in rustdoc.
@adevore added example writing a &str for fs::write.
@sanxiyn updated the man page with additional –print options.
@shepmaster fixed UnsafeCell doc typos and minor flow improvements.
@frewsxcv fixed incorrect statement about return value for Iterator::zip.
@robinkrahl reordered description for snippets in rustdoc documentation.
@shamiao fixed a typo in signed-integer::from_str_radix().
@sinkuu fixed rustdoc panic with impl Trait in type parameters.
@GuillaumeGomez made some rustdoc improvements, added minification process, added auto-impl for primitive type and added missing error codes in libsyntax-ext asm.

Meetings

Next meeting will be on Tuesday 22nd of May 2018 at 19:00 UTC on #rust-docs channel on irc.mozilla.org. Feel free to come!

Written on May 21, 2018