This Week in Rust Docs 107

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 important enough.

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

@fkjogu documented round-off error in .mod_euc()-method.
@petrochenkov added deprecation lint for duplicated macro_exports and stabilize use_extern_macros.
@mandeep added doc comment to hiding portions of code example.
@ogham documented Vec’s particular IntoIter behaviour, mentioned spec and indented blocks in doctest docs.
@kennytm pointed to the rustdoc attribute where intralink resolution failed.
@teiesti updated rustdoc book to suggest using Termination trait instead of hidden ‘foo’ function.
@kornelski used String, not &str in some collection examples.
@avdv fixed confusing error message for sub_instant.
@Aaronepower updated RELEASES.md for 1.27.0.
@cmdd added error message for using >= 65535 hashes for raw string literal escapes.
@GuillaumeGomez fixed extern prelude failure in rustdoc, introduce the #[doc(keyword=””)] attribute for documenting keywords and fixed crate-name option in rustdoc.

Recent doc contributions

@F001 added lint for multiple associated types.
@frewsxcv provided more context for what the {f32,f64}::EPSILON values represent, clarified the difference between get_mut and into_mut for OccupiedEntry, reworded {ptr,mem}::replace docs and added doc link from discriminant struct to function.
@davidtwco added rustdoc documentation to compiler docs.
@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 and hid macro export statements from docs.
@euclio used type name in E0599 enum variant suggestion.
@evincarofautumn fixed typos of ‘ambiguous’.
@steveklabnik removed feature flag from fs::read_to_string example.
@petrochenkov fixed naming conventions for new lints.
@crlf0710 replaced if with if and only if in the definition dox of Sync.
@estebank tweaked output on E0599 for assoc fn used as method and suggested using as_ref on some borrow errors [hack].
@akoserwal updated build instructions.
@RalfJung extended from_raw_parts docs for slices and strs to mention alignment requirement.
@nickbabcock documented additional use case for iter::inspect.
@GuillaumeGomez stabilized short error format, added E0665, fixed run button style, added attributes for trait and methods as well, stabilize Formatter alignment, added missing whitespace in num example and fixed some style issues in rustdoc “implementations on Foreign types”.

Meetings

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

Written on June 3, 2018