Clippy lints / Pedantic
Clippy lint · Pedantic · checked with Clippy 0.1.99
clippy::missing_errors_doc: Checks the doc comments of publicly visible functions that return a Result type and warns if there is no # Errors section
What it meansChecks the doc comments of publicly visible functions that return a Result type and warns if there is no # Errors section. It is in the pedantic group and off by default.
Does it matter?
Documenting the type of errors that can be returned from a function can help callers write code to handle the errors appropriately.
Stricter lints with some false positives. Off by default; opt in with clippy::pedantic.
How to fix it
Clippy does not fix this one automatically. Change the code by hand:
Flagged
/// # Errors
///
/// Will return `Err` if `filename` does not exist or the user does not have
/// permission to read it.
pub fn read(filename: String) -> io::Result<String> {
unimplemented!();
}
Turn it off, or on
It is off by default. To use it, set it to warn or deny:
Whole crate (Cargo.toml)
[lints.clippy]
missing_errors_doc = "warn"In code
#![warn(clippy::missing_errors_doc)]One run
cargo clippy -- -W clippy::missing-errors-docThe [lints] table needs Rust 1.74 or newer. In a workspace, put it under [workspace.lints.clippy] and add [lints] workspace = true to each member.
Settings in clippy.toml
check-private-items: Whether to also run the listed lints on private items.
Clippy's own documentation
What it does
Checks the doc comments of publicly visible functions that
return a Result type and warns if there is no # Errors section.
Why is this bad?
Documenting the type of errors that can be returned from a function can help callers write code to handle the errors appropriately.
Examples
Since the following function returns a Result it has an # Errors section in
its doc comment:
/// # Errors
///
/// Will return `Err` if `filename` does not exist or the user does not have
/// permission to read it.
pub fn read(filename: String) -> io::Result<String> {
unimplemented!();
}
Configuration
-
check-private-items: Whether to also run the listed lints on private items.(default:
false)
From the Clippy lint list (0.1.99), part of the Rust project, MIT or Apache-2.0. Official entry.
Related lints
- too_many_linesChecks for functions with a large amount of lines
- must_use_candidateChecks for public functions that have no #[must_use] attribute, but return something not already marked must-use, have no mutable arg and mutate no statics
- uninlined_format_argsDetect when a variable is not inlined in a format string, and suggests to inline it
- match_wildcard_for_single_variantsChecks for wildcard enum matches for a single variant
- maybe_infinite_iterChecks for iteration that may be infinite
- mismatching_type_param_order`Foo` has a similarly named generic type parameter `B` in its declaration, but in a different order
- missing_fields_in_debugmanual `Debug` impl does not include all fields
- missing_panics_docChecks the doc comments of publicly visible functions that may panic and warns if there is no # Panics section
All 847 Clippy lints · Rust compiler errors · Cargo.toml checker
Up next
Related lintclippy::too_many_linesChecks for functions with a large amount of linesRead it next →Did this answer your question?