rust-lang/rust-clippy

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

Open

#1790 opened on May 27, 2017

View on GitHub
 (1 comment) (0 reactions) (1 assignee)Rust (10,406 stars) (1,391 forks)batch import
A-lintL-guidelinesT-middlegood first issue

Description

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

Contributor guide

Tech stack
rust
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Rustclippy lint development
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
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.