Skip to main content

Lint clippy::doc_markdown

warning clippy::doc_markdown §

item in documentation is missing backticks

examples/update_lint_metadata.rs:2:32

Clippy · Category: pedantic · cargo-clippy-html

Official Clippy documentation

Targets (1)
  • update_lint_metadata (example)

Primary: examples/update_lint_metadata.rs:2:32

//! Usage: cargo run --example update_lint_metadata -- INPUT SELECTOR DATE OUTPUT

help: for further information visit https://rust-lang.github.io/rust-clippy/rust-1.100.0/index.html#doc_markdown

note: `-W clippy::doc-markdown` implied by `-W clippy::pedantic`

help: to override `-W clippy::pedantic` add `#[allow(clippy::doc_markdown)]`

help: try

Suggestion: try

MachineApplicable

--- "a/examples/update_lint_metadata.rs"
+++ "b/examples/update_lint_metadata.rs"
@@ -1,5 +1,5 @@
 //! Generate the bundled category table from a local official HTML snapshot.
-//! Usage: cargo run --example update_lint_metadata -- INPUT SELECTOR DATE OUTPUT
+//! Usage: cargo run --example `update_lint_metadata` -- INPUT SELECTOR DATE OUTPUT
 #[path = "../src/diagnostic/mod.rs"]
 #[allow(dead_code)]
 mod diagnostic;
Rendered diagnostic (text)
warning: item in documentation is missing backticks
 --> examples/update_lint_metadata.rs:2:32
  |
2 | //! Usage: cargo run --example update_lint_metadata -- INPUT SELECTOR DATE OUTPUT
  |                                ^^^^^^^^^^^^^^^^^^^^
  |
  = help: for further information visit https://rust-lang.github.io/rust-clippy/rust-1.100.0/index.html#doc_markdown
  = note: `-W clippy::doc-markdown` implied by `-W clippy::pedantic`
  = help: to override `-W clippy::pedantic` add `#[allow(clippy::doc_markdown)]`
help: try
  |
2 - //! Usage: cargo run --example update_lint_metadata -- INPUT SELECTOR DATE OUTPUT
2 + //! Usage: cargo run --example `update_lint_metadata` -- INPUT SELECTOR DATE OUTPUT
  |