about summary refs log tree commit diff
path: root/src/docs/missing_errors_doc.txt
diff options
context:
space:
mode:
authorPhilipp Krones <hello@philkrones.com>2022-11-21 20:34:47 +0100
committerPhilipp Krones <hello@philkrones.com>2022-11-21 20:51:52 +0100
commit46c5a5d234f13dcf4bb4cf4241b2addedbf0be14 (patch)
tree56726625e55224ecb09ed11f509a964507b9c333 /src/docs/missing_errors_doc.txt
parent3597ed5a099488aa77caf444106a0550b7e5d2e8 (diff)
downloadrust-46c5a5d234f13dcf4bb4cf4241b2addedbf0be14.tar.gz
rust-46c5a5d234f13dcf4bb4cf4241b2addedbf0be14.zip
Merge commit 'f4850f7292efa33759b4f7f9b7621268979e9914' into clippyup
Diffstat (limited to 'src/docs/missing_errors_doc.txt')
-rw-r--r--src/docs/missing_errors_doc.txt21
1 files changed, 0 insertions, 21 deletions
diff --git a/src/docs/missing_errors_doc.txt b/src/docs/missing_errors_doc.txt
deleted file mode 100644
index 028778d85ae..00000000000
--- a/src/docs/missing_errors_doc.txt
+++ /dev/null
@@ -1,21 +0,0 @@
-### 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