Clippy lints / Pedantic
Clippy lint · Pedantic · checked with Clippy 0.1.99
clippy::doc_comment_double_space_linebreaks: Detects doc comments that use double spaces as hard line break, instead of backslash (\)
What it meansDetects doc comments that use double spaces as hard line break, instead of backslash (\). It is in the pedantic group and off by default.
Does it matter?
Double spaces, when used as hard line break in doc comments, can be difficult to see, and may accidentally be removed during automatic formatting or manual refactoring. The use of a backslash (\) is clearer in this regard.
Stricter lints with some false positives. Off by default; opt in with clippy::pedantic.
How to fix it
Clippy can fix this one for you: run cargo clippy --fix (add --allow-dirty if you have uncommitted changes). Review the diff before you commit.
Flagged
/// This function adds two numbers and returns the result··
/// Overflow can occur when the max value is exceeded.
fn add(l: i32, r: i32) -> i32 {
l + r
}
Write this instead
/// This function adds two numbers and returns the result\
/// Overflow can occur when the max value is exceeded.
fn add(l: i32, r: i32) -> i32 {
l + r
}
Turn it off, or on
It is off by default. To use it, set it to warn or deny:
Whole crate (Cargo.toml)
[lints.clippy]
doc_comment_double_space_linebreaks = "warn"In code
#![warn(clippy::doc_comment_double_space_linebreaks)]One run
cargo clippy -- -W clippy::doc-comment-double-space-linebreaksThe [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 doc comments that use double spaces as hard line break, instead of backslash (\).
Why is this bad?
Double spaces, when used as hard line break in doc comments, can be difficult to see, and may
accidentally be removed during automatic formatting or manual refactoring. The use of a backslash (\)
is clearer in this regard.
Example
The two replacement dots (··) in this example represent a double space.
/// This function adds two numbers and returns the result··
/// Overflow can occur when the max value is exceeded.
fn add(l: i32, r: i32) -> i32 {
l + r
}
Use instead:
/// This function adds two numbers and returns the result\
/// Overflow can occur when the max value is exceeded.
fn add(l: i32, r: i32) -> i32 {
l + r
}
From the Clippy lint list (0.1.99), part of the Rust project, MIT or Apache-2.0. Official entry.
Related lints
- too_many_linesChecks for functions with a large amount of lines
- missing_errors_docChecks the doc comments of publicly visible functions that return a Result type and warns if there is no # Errors section
- must_use_candidateChecks for public functions that have no #[must_use] attribute, but return something not already marked must-use, have no mutable arg and mutate no statics
- decimal_bitwise_operandsusing decimal literal for bitwise operation
- default_trait_accesscalling `String::default()` is more clear than this expression
- doc_broken_linkpossible broken doc link: broken across multiple lines
- doc_link_with_quotespossible intra-doc link using quotes instead of backticks
- doc_markdownitem in documentation is missing backticks
- duration_suboptimal_unitsconstructing a `Duration` using a smaller unit when a larger unit would be more readable
All 847 Clippy lints · Rust compiler errors · Cargo.toml checker
Up next
Related lintclippy::too_many_linesChecks for functions with a large amount of linesRead it next →Did this answer your question?