diff options
Diffstat (limited to 'src/tools/clippy/src/docs/missing_errors_doc.txt')
-rw-r--r-- | src/tools/clippy/src/docs/missing_errors_doc.txt | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/src/tools/clippy/src/docs/missing_errors_doc.txt b/src/tools/clippy/src/docs/missing_errors_doc.txt new file mode 100644 index 000000000..028778d85 --- /dev/null +++ b/src/tools/clippy/src/docs/missing_errors_doc.txt @@ -0,0 +1,21 @@ +### 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!(); +} +```
\ No newline at end of file |