mirror of
https://github.com/rust-lang/rust-clippy
synced 2024-11-15 01:17:16 +00:00
f5d0a452ba
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.
34 lines
1 KiB
Text
34 lines
1 KiB
Text
error: docs for function returning `Result` missing `# Errors` section
|
|
--> $DIR/doc_errors.rs:5:1
|
|
|
|
|
LL | / pub fn pub_fn_missing_errors_header() -> Result<(), ()> {
|
|
LL | | unimplemented!();
|
|
LL | | }
|
|
| |_^
|
|
|
|
|
= note: `-D clippy::missing-errors-doc` implied by `-D warnings`
|
|
|
|
error: docs for function returning `Result` missing `# Errors` section
|
|
--> $DIR/doc_errors.rs:10:1
|
|
|
|
|
LL | / pub fn pub_fn_returning_io_result() -> io::Result<()> {
|
|
LL | | unimplemented!();
|
|
LL | | }
|
|
| |_^
|
|
|
|
error: docs for function returning `Result` missing `# Errors` section
|
|
--> $DIR/doc_errors.rs:29:5
|
|
|
|
|
LL | / pub fn pub_method_missing_errors_header() -> Result<(), ()> {
|
|
LL | | unimplemented!();
|
|
LL | | }
|
|
| |_____^
|
|
|
|
error: docs for function returning `Result` missing `# Errors` section
|
|
--> $DIR/doc_errors.rs:47:5
|
|
|
|
|
LL | fn trait_method_missing_errors_header() -> Result<(), ()>;
|
|
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
error: aborting due to 4 previous errors
|
|
|