rust-lang/rust-clippy

Document `pub` functions in `clippy_utils`

Open

#15,569 创建于 2025年8月26日

在 GitHub 查看
 (11 评论) (0 反应) (1 负责人)Rust (1,391 fork)batch import
good first issue

仓库指标

Star
 (10,406 star)
PR 合并指标
 (平均合并 19天 22小时) (30 天内合并 113 个 PR)

描述

Description

Quite a lot of functions in clippy_utils lack documentation. Ideally, the missing_docs lint should be enabled on this crate, except for selected entities such as the static path definitions in the paths module (which might be moved into a submodule).

Note: we are not looking for LLM generated verbose documentation.

Version

Additional Labels

@rustbot label "+good first issue"

贡献者指南

研究方向
识别 `clippy utils` crate 中所有缺少文档的公共函数，并添加简洁、人工编写的文档注释。
技术栈
rust
领域
tooling
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
1
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
Rust
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
90