rust-lang/rust-clippy

Split `missing_docs_in_private_items` into various lints

Open

#5736 opened on Jun 22, 2020

View on GitHub
 (7 comments) (6 reactions) (0 assignees)Rust (10,406 stars) (1,391 forks)batch import
C-enhancementgood first issue

Description

Would it be feasible and acceptable to split missing_docs_in_private_items into a few different lints? I find myself quite frequently adding #[allow] to enum variants and struct fields, in large part because the naming is typically self-explanatory. Even splitting the lint in two (fields/variants and everything else) would be incredibly useful for me, and would avoid cluttering declarations with unnecessary (imo) #[allow] attributes.

Having different lints for modules and top-level crate documentation would also be great, but are less important to me.

Contributor guide

Tech stack
rust
Domain
toolingdeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Rust programmingclippy development basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
The issue proposes splitting `missing docs in private items` into separate lints for fields/variants and other items. To implement, look at the current lint definition in clippy's source code, likely in a file like `clippy lints/src/missing docs.rs`. The maintainers have discussed this (see comments); no linked PRs. A solution would involve creating new lint IDs, updating the lint registry, and possibly adding configuration options. Test existing lint behavior and ensure the split doesn't break any existing functionality.