Rust API Guideline: Function docs include error conditions in "Errors" section

描述

贡献者指南

技术栈

rust

领域

documentation

议题类型

documentation

难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。

3

预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。

1-2 days

活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。

blocked

清晰度议题是否清楚说明期望改动、验收标准和下一步。

mostly clear

前置要求

Rustclippy lint development

新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。

40

研究方向

Explore existing clippy lints related to documentation, such as missing docs. Understand the structure for adding a new lint. The issue references Rust API guidelines; review the specific guideline about error documentation. Check if the assignee has any work in progress. The lint should verify that function docs contain an 'Errors' section when the function returns Result or similar. Relevant files: clippy lints/src/ directory.