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

説明

コントリビューターガイド

技術スタック

rust

領域

documentation

Issue 種別

documentation

難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。

3

推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。

1-2 days

活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。

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.