rust-lang/rust-clippy

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

Open

#1,790 opened on May 27, 2017

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

Repository metrics

Stars
 (10,406 stars)
PR merge metrics
 (Avg merge 19d 22h) (113 merged PRs in 30d)

Description

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

Contributor guide

Research direction
Review the Rust API guideline on documenting error conditions. Find Clippy lint functions missing an 'Errors' section in their doc comments and add it.
Tech stack
rust
Domain
documentationdeveloper experience
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitRust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85