RS.CLIPPY.MISSING_DOCS_IN_PRIVATE_ITEMS

Detects missing documentation for private members

This checker is a Clippy lint created by The Rust Project Contributors. The documentation shown here is a copy of the original documentation for: missing_docs_in_private_items. Copyright ©2025 The Rust Team. All rights reserved.

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)