summaryrefslogtreecommitdiffstats
path: root/src/tools/clippy/src/docs/mut_mut.txt
diff options
context:
space:
mode:
Diffstat (limited to 'src/tools/clippy/src/docs/mut_mut.txt')
-rw-r--r--src/tools/clippy/src/docs/mut_mut.txt12
1 files changed, 12 insertions, 0 deletions
diff --git a/src/tools/clippy/src/docs/mut_mut.txt b/src/tools/clippy/src/docs/mut_mut.txt
new file mode 100644
index 000000000..0bd34dd24
--- /dev/null
+++ b/src/tools/clippy/src/docs/mut_mut.txt
@@ -0,0 +1,12 @@
+### What it does
+Checks for instances of `mut mut` references.
+
+### Why is this bad?
+Multiple `mut`s don't add anything meaningful to the
+source. This is either a copy'n'paste error, or it shows a fundamental
+misunderstanding of references.
+
+### Example
+```
+let x = &mut &mut y;
+``` \ No newline at end of file