Clippy lints / Restriction
Clippy lint · Restriction · checked with Clippy 0.1.99
clippy::missing_docs_in_private_items: Warns if there is missing documentation for any private documentable item
What it meansWarns if there is missing documentation for any private documentable item. It is in the restriction group and off by default.
Does it matter?
Doc is good. rustc has a MISSING_DOCS allowed-by-default lint for public members, but has no way to enforce documentation of private items. This lint fixes that.
Lints that forbid language features for specific codebases (no unwrap, no indexing...). Off by default; pick them one by one, never the whole group.
How to fix it
Clippy does not fix this one automatically. Change the code by hand:
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]
missing_docs_in_private_items = "warn"In code
#![warn(clippy::missing_docs_in_private_items)]One run
cargo clippy -- -W clippy::missing-docs-in-private-itemsThe [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.
Settings in clippy.toml
missing-docs-allow-unused: Whether to allow fields starting with an underscore to skip documentation requirementsmissing-docs-in-crate-items: Whether to only check for missing documentation in items visible within the current crate. For example, pub(crate) items.
Clippy's own documentation
What it does
Warns if there is missing documentation for any private documentable item.
Why restrict this?
Doc is good. rustc has a MISSING_DOCS
allowed-by-default lint for
public members, but has no way to enforce documentation of private items.
This lint fixes that.
Configuration
-
missing-docs-allow-unused: Whether to allow fields starting with an underscore to skip documentation requirements(default:
false) -
missing-docs-in-crate-items: Whether to only check for missing documentation in items visible within the current crate. For example,pub(crate)items.(default:
false)
From the Clippy lint list (0.1.99), part of the Rust project, MIT or Apache-2.0. Official entry.
Related lints
- unwrap_usedChecks for .unwrap() or .unwrap_err() calls on Results and .unwrap() call on Options
- module_name_repetitionsDetects public item names that are prefixed or suffixed by the containing public module’s name
- expect_usedChecks for .expect() or .expect_err() calls on Results and .expect() call on Options
- min_ident_charsChecks for identifiers which consist of a single character (or fewer than the configured threshold). Note: This lint can be very noisy when enabled; it may be desirable to only enable it temporarily
- missing_assert_messageChecks assertions without a custom panic message
- missing_asserts_for_indexingindexing into a slice multiple times without an `assert`
- missing_inline_in_public_itemsmissing `#[inline]` on a publicly callable function
- missing_trait_methodsChecks if a provided method is used implicitly by a trait implementation
- mixed_read_write_in_expressionunsequenced read of `x`
All 847 Clippy lints · Rust compiler errors · Cargo.toml checker
Up next
Related lintclippy::unwrap_usedChecks for .unwrap() or .unwrap_err() calls on Results and .unwrap() call on OptionsRead it next →Did this answer your question?