added wiki comments + wiki-generating python script

[rust.git] / src / needless_bool.rs

diff --git a/src/needless_bool.rs b/src/needless_bool.rs
index e4d3b00218ed3fcaa23b7d130f12273379a556db..bd2e4116fd01d27596252355be54ba78b5903a74 100644 (file)
--- a/src/needless_bool.rs
+++ b/src/needless_bool.rs
@@ -9,6 +9,13 @@
 
 use utils::{span_lint, snippet};
 
+/// **What it does:** This lint checks for expressions of the form `if c { true } else { false }` (or vice versa) and suggest using the condition directly. It is `Warn` by default.
+///
+/// **Why is this bad?** Redundant code.
+///
+/// **Known problems:** Maybe false positives: Sometimes, the two branches are painstakingly documented (which we of course do not detect), so they *may* have some value. Even then, the documentation can be rewritten to match the shorter code.
+///
+/// **Example:** `if x { false } else { true }`
 declare_lint! {
     pub NEEDLESS_BOOL,
     Warn,