Add comment explaining what the matching items are for TOO_LONG_FIRST_DOC_PARAGRAPH lint

This commit is contained in:
Guillaume Gomez 2024-07-21 17:29:32 +02:00
parent 4969960a9c
commit 3c6e5ef4ae

View file

@ -21,6 +21,8 @@ pub(super) fn check(
if first_paragraph_len <= 200 if first_paragraph_len <= 200
|| !matches!( || !matches!(
item.kind, 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::Static(..)
| ItemKind::Const(..) | ItemKind::Const(..)
| ItemKind::Fn(..) | ItemKind::Fn(..)