Clippy lints / Style
Clippy lint · Style · checked with Clippy 0.1.99
clippy::doc_overindented_list_items: Detects overindented list items in doc comments where the continuation lines are indented more than necessary
What it meansDetects overindented list items in doc comments where the continuation lines are indented more than necessary. It is in the style group and warns by default.
Does it matter?
Overindented list items in doc comments can lead to inconsistent and poorly formatted documentation when rendered. Excessive indentation may cause the text to be misinterpreted as a nested list item or code block, affecting readability and the overall structure of the documentation.
Code that works but is not idiomatic Rust. Warns by default.
How to fix it
Clippy does not fix this one automatically (its suggestion may change behaviour, so it only shows it). Change the code by hand:
Flagged
/// - This is the first item in a list
/// and this line is overindented.
Write this instead
/// - This is the first item in a list
/// and this line is overindented.
Turn it off, or on
Allow it where it does not fit your code, as narrowly as you can:
On one item
#[allow(clippy::doc_overindented_list_items)]
fn my_function() { /* ... */ }Whole crate (Cargo.toml)
[lints.clippy]
doc_overindented_list_items = "allow"One run
cargo clippy -- -A clippy::doc-overindented-list-itemsThe [lints] table needs Rust 1.74 or newer. In a workspace, put it under [workspace.lints.clippy] and add [lints] workspace = true to each member.
Clippy's own documentation
What it does
Detects overindented list items in doc comments where the continuation lines are indented more than necessary.
Why is this bad?
Overindented list items in doc comments can lead to inconsistent and poorly formatted documentation when rendered. Excessive indentation may cause the text to be misinterpreted as a nested list item or code block, affecting readability and the overall structure of the documentation.
Example
/// - This is the first item in a list
/// and this line is overindented.
Fixes this into:
/// - This is the first item in a list
/// and this line is overindented.
From the Clippy lint list (0.1.99), part of the Rust project, MIT or Apache-2.0. Official entry.
Related lints
- needless_returnunneeded `return` statement
- new_without_defaultChecks for public types with a pub fn new() -> Self method and no implementation of Default
- len_zeroChecks for getting the length of something via .len() just to compare to zero, and suggests using .is_empty() where applicable
- disallowed_namesuse of a disallowed/placeholder name `foo`
- disallowed_typesDenies the configured types in clippy.toml. Note: Even though this lint is warn-by-default, it will only trigger if types are defined in the clippy.toml file
- doc_lazy_continuationdoc quote line without `>` marker
- double_must_usethis function has a `#[must_use]` attribute with no message, but returns a type already considered as `#[must_use]`
- duplicate_underscore_argument`a` already exists, having another argument having almost the same name makes code comprehension and documentation more difficult
- enum_variant_namesvariant name ends with the enum's name
All 847 Clippy lints · Rust compiler errors · Cargo.toml checker
Up next
Related lintclippy::needless_returnunneeded `return` statementRead it next →Did this answer your question?