Summary
Pretty much the title. Clippy lints on clippy::doc_markdown when it detects common database engine names, such as:
- SQLite
- MySQL
- PostgresSQL
- MariaDB
Lint Name
clippy::doc_markdown
Reproducer
While writing a comment referencing SQLite:
#![warn(clippy::doc_markdown)]
/// Performs an SQLite call
fn _some_sqlite_call() {
todo!()
}
cargo clippy returns the following warning:
warning: item in documentation is missing backticks
--> src/lib.rs:3:17
|
3 | /// Performs an SQLite call
| ^^^^^^
|
= help: for further information visit https://rust-lang.github.io/rust-clippy/rust-1.95.0/index.html#doc_markdown
--snip--
help: try
|
3 - /// Performs an SQLite call
3 + /// Performs an `SQLite` call
|
This should not happen, as SQLite is referring to a piece of software - and from my understanding, clippy tends to allow software-related terms to bypass this lint.
Version
rustc 1.95.0 (59807616e 2026-04-14)
binary: rustc
commit-hash: 59807616e1fa2540724bfbac14d7976d7e4a3860
commit-date: 2026-04-14
host: x86_64-pc-windows-msvc
release: 1.95.0
LLVM version: 22.1.2
Additional Labels
No response
Summary
Pretty much the title. Clippy lints on
clippy::doc_markdownwhen it detects common database engine names, such as:Lint Name
clippy::doc_markdown
Reproducer
While writing a comment referencing SQLite:
cargo clippyreturns the following warning:This should not happen, as SQLite is referring to a piece of software - and from my understanding, clippy tends to allow software-related terms to bypass this lint.
Version
Additional Labels
No response