Clippy lints / Pedantic
Clippy lint · Pedantic · checked with Clippy 0.1.99
clippy::doc_broken_link: possible broken doc link: broken across multiple lines
What it meansChecks the doc comments have unbroken links, mostly caused by bad formatted links such as broken across multiple lines. It is in the pedantic group and off by default.
What you see
warning: possible broken doc link: broken across multiple lines --> main.rs:3:5 | 3 | /// [example of a bad link](https:// | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/stable/index.html#doc_broken_link = note: `-W clippy::doc-broken-link` implied by `-W clippy::pedantic`
Real output of Clippy 0.1.99 (Rust 1.99) on the example below. Names and line numbers in yours will differ.
Does it matter?
Because documentation generated by rustdoc will be broken since expected links won’t be links and just text.
Stricter lints with some false positives. Off by default; opt in with clippy::pedantic.
How to fix it
Clippy does not fix this one automatically. Change the code by hand:
Flagged
/// [example of a bad link](https://
/// github.com/rust-lang/rust-clippy/)
pub fn do_something() {}
Write this instead
/// [example of a good link](https://github.com/rust-lang/rust-clippy/)
pub fn do_something() {}
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_broken_link = "warn"In code
#![warn(clippy::doc_broken_link)]One run
cargo clippy -- -W clippy::doc-broken-linkThe [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
Checks the doc comments have unbroken links, mostly caused by bad formatted links such as broken across multiple lines.
Why is this bad?
Because documentation generated by rustdoc will be broken since expected links won’t be links and just text.
Examples
This link is broken:
/// [example of a bad link](https://
/// github.com/rust-lang/rust-clippy/)
pub fn do_something() {}
It shouldn’t be broken across multiple lines to work:
/// [example of a good link](https://github.com/rust-lang/rust-clippy/)
pub fn do_something() {}
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
- copy_iteratorChecks for types that implement Copy as well as Iterator
- decimal_bitwise_operandsusing decimal literal for bitwise operation
- default_trait_accesscalling `String::default()` is more clear than this expression
- doc_comment_double_space_linebreaksDetects doc comments that use double spaces as hard line break, instead of backslash (\)
- doc_link_with_quotespossible intra-doc link using quotes instead of backticks
- doc_markdownitem in documentation is missing backticks
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?