RS.CLIPPY.TOO_LONG_FIRST_DOC_PARAGRAPH

Ensure the first documentation paragraph is short

This checker is a Clippy lint created by The Rust Project Contributors. The documentation shown here is a copy of the original documentation for: too_long_first_doc_paragraph. Copyright ©2025 The Rust Team. All rights reserved.

What it does

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 docstring in the summary page of a module. Having a nice, short summary in the first paragraph is part of writing good docs.

Example

/// A very short summary.
/// A much longer explanation that goes into a lot more detail about
/// how the thing works, possibly with doclinks and so one,
/// and probably spanning a many rows.
struct Foo {}

Use instead:

/// A very short summary.
///
/// A much longer explanation that goes into a lot more detail about
/// how the thing works, possibly with doclinks and so one,
/// and probably spanning a many rows.
struct Foo {}