rust-lang/rust-clippy

Split `missing_docs_in_private_items` into various lints

Open

#5,736 创建于 2020年6月22日

在 GitHub 查看
 (7 评论) (6 反应) (0 负责人)Rust (10,406 star) (1,391 fork)batch import
C-enhancementgood first issue

描述

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.

贡献者指南

技术栈
rust
领域
toolingdeveloper experience
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Rust programmingclippy development basics
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
50
研究方向
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.