diff options
| author | Guillaume Gomez <guillaume1.gomez@gmail.com> | 2024-07-21 17:29:32 +0200 |
|---|---|---|
| committer | Guillaume Gomez <guillaume1.gomez@gmail.com> | 2024-07-26 11:21:32 +0200 |
| commit | 3c6e5ef4ae20c7439a2bc951ef349c59954412c6 (patch) | |
| tree | 23d73e25323ced65acd82df64c31822c1aabbc16 | |
| parent | 4969960a9c0a9ac4e8bbe0083124186eb5159028 (diff) | |
| download | rust-3c6e5ef4ae20c7439a2bc951ef349c59954412c6.tar.gz rust-3c6e5ef4ae20c7439a2bc951ef349c59954412c6.zip | |
Add comment explaining what the matching items are for `TOO_LONG_FIRST_DOC_PARAGRAPH` lint
| -rw-r--r-- | clippy_lints/src/doc/too_long_first_doc_paragraph.rs | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/clippy_lints/src/doc/too_long_first_doc_paragraph.rs b/clippy_lints/src/doc/too_long_first_doc_paragraph.rs index 45ec392d553..a47cba64b28 100644 --- a/clippy_lints/src/doc/too_long_first_doc_paragraph.rs +++ b/clippy_lints/src/doc/too_long_first_doc_paragraph.rs @@ -21,6 +21,8 @@ pub(super) fn check( if first_paragraph_len <= 200 || !matches!( item.kind, + // This is the list of items which can be documented AND are displayed on the module + // page. So associated items or impl blocks are not part of this list. ItemKind::Static(..) | ItemKind::Const(..) | ItemKind::Fn(..) |