rust-lang / rust-lang/rust-clippy

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

Open
#1,790 1 comment 0 reactions 1 assignee View on GitHub

@mcarton is already working on this.

Since Jun 17, 2017.

A-lint good first issue L-guidelines T-middle
Dominant language
Rust
Stars
13.5k
Forks
2.2k
Avg merge
2d 10h
Merged PRs (30d)
32

Description

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.