diff options
| -rw-r--r-- | book/src/lint_configuration.md | 3 | ||||
| -rw-r--r-- | clippy_lints/src/missing_doc.rs | 3 |
2 files changed, 4 insertions, 2 deletions
diff --git a/book/src/lint_configuration.md b/book/src/lint_configuration.md index 46bed62dfc9..f74431bee82 100644 --- a/book/src/lint_configuration.md +++ b/book/src/lint_configuration.md @@ -542,7 +542,8 @@ if no suggestion can be made. ### missing-docs-in-crate-items -Whether to **only** check for missing documentation in `pub(crate)` items. +Whether to **only** check for missing documentation in items visible within the current +crate. For example, `pub(crate)` items. **Default Value:** `false` (`bool`) diff --git a/clippy_lints/src/missing_doc.rs b/clippy_lints/src/missing_doc.rs index 74592918bfc..9659ca8ced2 100644 --- a/clippy_lints/src/missing_doc.rs +++ b/clippy_lints/src/missing_doc.rs @@ -36,7 +36,8 @@ declare_clippy_lint! { } pub struct MissingDoc { - /// Whether to only check for missing docs in `pub(crate)` items. + /// Whether to **only** check for missing documentation in items visible within the current + /// crate. For example, `pub(crate)` items. crate_items_only: bool, /// Stack of whether #[doc(hidden)] is set /// at each level which has lint attributes. |