Skip to content

Commit 9cf416d

Browse files
committed
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
2 parents 6bcd0b9 + 0bcc6f8 commit 9cf416d

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

clippy_lints/src/doc/mod.rs

+4-4
Original file line numberDiff line numberDiff line change
@@ -427,11 +427,11 @@ declare_clippy_lint! {
427427

428428
declare_clippy_lint! {
429429
/// ### What it does
430-
/// Checks if the first line in the documentation of items listed in module page is too long.
430+
/// Checks if the first paragraph in the documentation of items listed in the module page is too long.
431431
///
432432
/// ### Why is this bad?
433-
/// Documentation will show the first paragraph of the doscstring in the summary page of a
434-
/// module, so having a nice, short summary in the first paragraph is part of writing good docs.
433+
/// Documentation will show the first paragraph of the docstring in the summary page of a
434+
/// module. Having a nice, short summary in the first paragraph is part of writing good docs.
435435
///
436436
/// ### Example
437437
/// ```no_run
@@ -453,7 +453,7 @@ declare_clippy_lint! {
453453
#[clippy::version = "1.82.0"]
454454
pub TOO_LONG_FIRST_DOC_PARAGRAPH,
455455
nursery,
456-
"ensure that the first line of a documentation paragraph isn't too long"
456+
"ensure the first documentation paragraph is short"
457457
}
458458

459459
declare_clippy_lint! {

0 commit comments

Comments
 (0)