Skip to content

[clippy::doc_markdown] Default whitelist: Add 'NixOS' #15360

@axelkar

Description

@axelkar

Summary

NixOS is a popular Linux distribution, and its name is not a Rust identifier, i.e. it should not be put into backticks.

Copy of #10998

This contains an acronym by the specification in #1136

Lint Name

clippy::doc_markdown

Reproducer

I tried this code:

#![warn(clippy::doc_markdown)]
//! example NixOS blah blah

I saw this happen:

warning: item in documentation is missing backticks
 --> src/lib.rs:2:13
  |
2 | //! example NixOS blah blah
  |             ^^^^^

I expected to see this happen:

No warnings

Version

clippy 0.1.88 (2025-06-23 6b00bc3880)
host: play.rust-lang.org?
release: stable 1.88.0

Additional Labels

No response

Metadata

Metadata

Assignees

Labels

C-bugCategory: Clippy is not doing the correct thingI-false-positiveIssue: The lint was triggered on code it shouldn't have

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions