Clippy lints / Nursery
Clippy lint · Nursery · checked with Clippy 0.1.99
clippy::doc_link_code: code link adjacent to code text
What it meansChecks for links with code directly adjacent to code text: [`MyItem`]`<`[`u32`]`>`. It is in the nursery group and off by default.
What you see
warning: code link adjacent to code text --> main.rs:3:5 | 3 | //! [`first`](x)`second` | ^^^^^^^^^^^^^^^^^^^^ | = help: separate code snippets will be shown with a gap = help: for further information visit https://rust-lang.github.io/rust-clippy/stable/index.html#doc_link_code = note: `-W clippy::doc-link-code` implied by `-W clippy::nursery` help: wrap the entire group in `<code>` tags | 3 - //! [`first`](x)`second` 3 + //! <code>[first](x)second</code> |
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 can be written more simply using HTML-style <code> tags.
New lints still being finished. Off by default and may have false positives.
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
//! [`first`](x)`second`
Write this instead
//! <code>[first](x)second</code>
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_code = "warn"In code
#![warn(clippy::doc_link_code)]One run
cargo clippy -- -W clippy::doc-link-codeThe [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 for links with code directly adjacent to code text:
[`MyItem`]`<`[`u32`]`>`.
Why is this bad?
It can be written more simply using HTML-style <code> tags.
Example
//! [`first`](x)`second`
Use instead:
//! <code>[first](x)second</code>
From the Clippy lint list (0.1.99), part of the Rust project, MIT or Apache-2.0. Official entry.
Related lints
- redundant_cloneChecks for a redundant clone() (and its relatives) which clones an owned value that is going to be dropped without further use
- collection_is_never_readChecks for collections that are never queried
- debug_assert_with_mut_callChecks for function/method calls with a mutable parameter in debug_assert!, debug_assert_eq! and debug_assert_ne! macros
- derive_partial_eq_without_eqChecks for types that derive PartialEq and could implement Eq
- empty_enumsChecks for enums with no variants, which therefore are uninhabited types (cannot be instantiated). As of this writing, the never_type is still a nightly-only experimental API. Therefore, this lint is only triggered if #![feature(never_type)] is enabled
- equatable_if_letChecks for pattern matchings that can be expressed using equality
- fallible_impl_fromconsider implementing `TryFrom` instead
All 847 Clippy lints · Rust compiler errors · Cargo.toml checker
Up next
Related lintclippy::redundant_cloneChecks for a redundant clone() (and its relatives) which clones an owned value that is going to be dropped without further useRead it next →Did this answer your question?