Clippy lints / Pedantic
Clippy lint · Pedantic · checked with Clippy 0.1.99
clippy::doc_link_with_quotes: possible intra-doc link using quotes instead of backticks
What it meansDetects the syntax ['foo'] in documentation comments (notice quotes instead of backticks) outside of code blocks It is in the pedantic group and off by default.
What you see
warning: possible intra-doc link using quotes instead of backticks --> main.rs:3:16 | 3 | /// See also: ['foo'] | ^^^^^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/stable/index.html#doc_link_with_quotes = note: `-W clippy::doc-link-with-quotes` 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?
It is likely a typo when defining an intra-doc link
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
/// See also: ['foo']
fn bar() {}
Write this instead
/// See also: [`foo`]
fn bar() {}
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_link_with_quotes = "warn"In code
#![warn(clippy::doc_link_with_quotes)]One run
cargo clippy -- -W clippy::doc-link-with-quotesThe [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 the syntax ['foo'] in documentation comments (notice quotes instead of backticks)
outside of code blocks
Why is this bad?
It is likely a typo when defining an intra-doc link
Example
/// See also: ['foo']
fn bar() {}
Use instead:
/// See also: [`foo`]
fn bar() {}
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
- default_trait_accesscalling `String::default()` is more clear than this expression
- doc_broken_linkpossible broken doc link: broken across multiple lines
- doc_comment_double_space_linebreaksDetects doc comments that use double spaces as hard line break, instead of backslash (\)
- doc_markdownitem in documentation is missing backticks
- duration_suboptimal_unitsconstructing a `Duration` using a smaller unit when a larger unit would be more readable
- elidable_lifetime_namesChecks for lifetime annotations which can be replaced with anonymous lifetimes ('_)
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?