diff options
| author | bors <bors@rust-lang.org> | 2024-10-24 19:29:29 +0000 |
|---|---|---|
| committer | bors <bors@rust-lang.org> | 2024-10-24 19:29:29 +0000 |
| commit | 9cf416dc6ec9d7ebc8df299ca970e4a92efa2596 (patch) | |
| tree | 190ee2ec3afe3ba22ca89d15b260006017adda0b | |
| parent | 6bcd0b9b4201c08ecd51f918fbc803182ff4655a (diff) | |
| parent | 0bcc6f81567149483e02814119e1b9d4175b952a (diff) | |
| download | rust-9cf416dc6ec9d7ebc8df299ca970e4a92efa2596.tar.gz rust-9cf416dc6ec9d7ebc8df299ca970e4a92efa2596.zip | |
Auto merge of #13586 - evanj:evan.jones/long-paragraph-edit, r=xFrednet
docs: Fix too_long_first_doc_paragraph: line -> paragraph The documentation for too_long_first_doc_paragraph incorrectly says "line" where it should say "paragraph". Fix a minor typo: doscstring -> docstring. Also do a few tiny edits to attempt to make the wording slightly shorter and clearer. changelog: [`too_long_first_doc_paragraph`]: Edit documentation
| -rw-r--r-- | clippy_lints/src/doc/mod.rs | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/clippy_lints/src/doc/mod.rs b/clippy_lints/src/doc/mod.rs index 89c6a4e08dc..df7c37a192a 100644 --- a/clippy_lints/src/doc/mod.rs +++ b/clippy_lints/src/doc/mod.rs @@ -427,11 +427,11 @@ declare_clippy_lint! { declare_clippy_lint! { /// ### What it does - /// Checks if the first line in the documentation of items listed in module page is too long. + /// Checks if the first paragraph in the documentation of items listed in the module page is too long. /// /// ### Why is this bad? - /// Documentation will show the first paragraph of the doscstring in the summary page of a - /// module, so having a nice, short summary in the first paragraph is part of writing good docs. + /// Documentation will show the first paragraph of the docstring in the summary page of a + /// module. Having a nice, short summary in the first paragraph is part of writing good docs. /// /// ### Example /// ```no_run @@ -453,7 +453,7 @@ declare_clippy_lint! { #[clippy::version = "1.82.0"] pub TOO_LONG_FIRST_DOC_PARAGRAPH, nursery, - "ensure that the first line of a documentation paragraph isn't too long" + "ensure the first documentation paragraph is short" } declare_clippy_lint! { |
