Rustdoc should only end the 1st sentence at a . that is followed by a space.
#8617
Labels
T-rustdoc
Relevant to the rustdoc team, which will review and decide on the PR/issue.
Comments
|
Right now rustdoc_web (the new docs) makes the cut between short description and the rest of the docblock at the first |
|
This is no longer relevant with rustdoc_ng. The detection of This can certainly be reopened if it's still a problem. |
flip1995
pushed a commit
to flip1995/rust
that referenced
this issue
May 5, 2022
…giraffate `needless_late_init`: ignore `if let`, `let mut` and significant drops No longer lints `if let`, personal taste on this one is pretty split, so it probably shouldn't be warning by default. Fixes rust-lang#8613 ```rust let x = if let Some(n) = y { n } else { 1 } ``` No longer lints `let mut`, things like the following are not uncommon and look fine as they are https://github.com/shepmaster/twox-hash/blob/b169c16d86eb8ea4a296b0acb9d00ca7e3c3005f/src/sixty_four.rs#L88-L93 Avoids changing the drop order in an observable way, where the type of `x` has a drop with side effects and something between `x` and the first use also does, e.g. https://github.com/denoland/rusty_v8/blob/48cc6cb791cac57d22fab1a2feaa92da8ddc9a68/tests/test_api.rs#L159-L167 The implementation of `type_needs_ordered_drop_inner` was changed a bit, it now uses `Ty::has_significant_drop` and reordered the ifs to check diagnostic name before checking the implicit drop impl changelog: [`needless_late_init`]: No longer lints `if let` statements, `let mut` bindings and no longer significantly changes drop order
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
For example, if the 1st sentence is "This is the foo library version 1.0 which does good stuff.", rustdoc will incorrectly consider the 1st sentence to be "This is the foo library version 1.".
The text was updated successfully, but these errors were encountered: