added wiki comments + wiki-generating python script

[rust.git] / src / mut_mut.rs

diff --git a/src/mut_mut.rs b/src/mut_mut.rs
index 06f76479c590f310586a0f810680d3196308cbfa..ade688d377ff9f7bc3f3c8567c69b2040be1f9e8 100644 (file)
--- a/src/mut_mut.rs
+++ b/src/mut_mut.rs
@@ -4,6 +4,13 @@
 
 use utils::{in_external_macro, span_lint};
 
+/// **What it does:** This lint checks for instances of `mut mut` references. It is `Warn` by default.
+///
+/// **Why is this bad?** Multiple `mut`s don't add anything meaningful to the source.
+///
+/// **Known problems:** None
+///
+/// **Example:** `let x = &mut &mut y;`
 declare_lint!(pub MUT_MUT, Allow,
               "usage of double-mut refs, e.g. `&mut &mut ...` (either copy'n'paste error, \
                or shows a fundamental misunderstanding of references)");