RS.CLIPPY.DOC_OVERINDENTED_LIST_ITEMS
Ensure list items are not overindented
This checker is a Clippy lint created by The Rust Project Contributors. The documentation shown here is a copy of the original documentation for: doc_overindented_list_items. Copyright ©2025 The Rust Team. All rights reserved.
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.