rust-clippy

Mirrors/rust-clippy

Fork 0

mirror of https://github.com/rust-lang/rust-clippy synced 2024-11-15 17:28:07 +00:00

Commit graph

Author SHA1 Message Date

Author	SHA1	Message	Date
daxpedda	0ee393cf01	Add tests and improve checks.	2020-02-17 14:43:38 +01:00
RobbieClarken	f5d0a452ba	Add lint for pub fns returning a `Result` without documenting errors The Rust Book recommends that functions that return a `Result` type have a doc comment with an `# Errors` section describing the kind of errors that can be returned (https://doc.rust-lang.org/book/ch14-02-publishing-to-crates-io.html#commonly-used-sections). This change adds a lint to enforce this. The lint is allow by default; it can be enabled with `#![warn(clippy::missing_errors_doc)]`. Closes #4854.	2019-12-06 17:19:05 +10:30

daxpedda

0ee393cf01

Add tests and improve checks.

2020-02-17 14:43:38 +01:00

RobbieClarken

f5d0a452ba

Add lint for pub fns returning a Result without documenting errors

The Rust Book recommends that functions that return a `Result` type have
a doc comment with an `# Errors` section describing the kind of errors
that can be returned
(https://doc.rust-lang.org/book/ch14-02-publishing-to-crates-io.html#commonly-used-sections).
This change adds a lint to enforce this. The lint is allow by default;
it can be enabled with `#![warn(clippy::missing_errors_doc)]`.

Closes #4854.

2019-12-06 17:19:05 +10:30

2 commits