Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
pvdrz committed Feb 20, 2023
1 parent c29e767 commit 790f28b
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
3 changes: 2 additions & 1 deletion book/src/lint_configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`)

Expand Down
3 changes: 2 additions & 1 deletion clippy_lints/src/missing_doc.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 790f28b

Please sign in to comment.