summaryrefslogtreecommitdiffstats
path: root/src/tools/clippy/src/docs/must_use_unit.txt
diff options
context:
space:
mode:
Diffstat (limited to 'src/tools/clippy/src/docs/must_use_unit.txt')
-rw-r--r--src/tools/clippy/src/docs/must_use_unit.txt13
1 files changed, 13 insertions, 0 deletions
diff --git a/src/tools/clippy/src/docs/must_use_unit.txt b/src/tools/clippy/src/docs/must_use_unit.txt
new file mode 100644
index 000000000..cabbb23f8
--- /dev/null
+++ b/src/tools/clippy/src/docs/must_use_unit.txt
@@ -0,0 +1,13 @@
+### What it does
+Checks for a `#[must_use]` attribute on
+unit-returning functions and methods.
+
+### Why is this bad?
+Unit values are useless. The attribute is likely
+a remnant of a refactoring that removed the return type.
+
+### Examples
+```
+#[must_use]
+fn useless() { }
+``` \ No newline at end of file