rust-lang/rust-clippy

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

Open

#1,790 建立於 2017年5月27日

在 GitHub 查看
 (1 留言) (0 反應) (1 負責人)Rust (10,406 star) (1,391 fork)batch import
A-lintL-guidelinesT-middlegood first issue

描述

As per Function docs include error, panic, and safety considerations.

貢獻者指南

技術棧
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.