From 0bcc6f81567149483e02814119e1b9d4175b952a Mon Sep 17 00:00:00 2001 From: Evan Jones Date: Tue, 22 Oct 2024 16:04:30 -0400 Subject: [PATCH] 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: Edit documentation for [`too_long_first_doc_paragraph`] --- clippy_lints/src/doc/mod.rs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/clippy_lints/src/doc/mod.rs b/clippy_lints/src/doc/mod.rs index 89c6a4e08dc4..df7c37a192ad 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! {