Mirrors/rust-clippy
2
0
Fork 0
mirror of https://github.com/rust-lang/rust-clippy synced 2024-12-19 01:24:05 +00:00
Code Issues Projects Releases Packages Wiki Activity
rust-clippy/clippy_lints
History
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
..
src Add lint for pub fns returning a Result without documenting errors 2019-12-06 17:19:05 +10:30
Cargo.toml Remove unused debugging feature 2019-11-25 17:23:07 +01:00
README.md rust-lang-nursery/rust-clippy => rust-lang/rust-clippy 2018-11-22 04:40:09 +01:00

README.md

This crate contains Clippy lints. For the main crate, check crates.io or GitHub.