From 2204bf20aea66c69b709e7a2338c316c50382ba5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Matthias=20Kr=C3=BCger?= <matthias.krueger@famsik.de>
Date: Wed, 18 Mar 2020 02:50:39 +0100
Subject: [PATCH] clean up a few lint docs

---
 clippy_lints/src/approx_const.rs            | 6 +++---
 clippy_lints/src/assertions_on_constants.rs | 4 +---
 clippy_lints/src/block_in_if_condition.rs   | 2 +-
 clippy_lints/src/needless_bool.rs           | 8 +++++++-
 clippy_lints/src/swap.rs                    | 2 +-
 clippy_lints/src/types.rs                   | 2 +-
 6 files changed, 14 insertions(+), 10 deletions(-)

diff --git a/clippy_lints/src/approx_const.rs b/clippy_lints/src/approx_const.rs
index 0e497e175d6..7e6e2c7eaeb 100644
--- a/clippy_lints/src/approx_const.rs
+++ b/clippy_lints/src/approx_const.rs
@@ -23,11 +23,11 @@ declare_clippy_lint! {
     ///
     /// **Example:**
     /// ```rust
-    /// // Bad
     /// let x = 3.14;
     /// let y = 1_f64 / x;
-    ///
-    /// // Good
+    /// ```
+    /// Use predefined constants instead:
+    /// ```rust
     /// let x = std::f32::consts::PI;
     /// let y = std::f64::consts::FRAC_1_PI;
     /// ```
diff --git a/clippy_lints/src/assertions_on_constants.rs b/clippy_lints/src/assertions_on_constants.rs
index bd9a2a7c40c..e2fe5f2400f 100644
--- a/clippy_lints/src/assertions_on_constants.rs
+++ b/clippy_lints/src/assertions_on_constants.rs
@@ -11,16 +11,14 @@ declare_clippy_lint! {
     /// **What it does:** Checks for `assert!(true)` and `assert!(false)` calls.
     ///
     /// **Why is this bad?** Will be optimized out by the compiler or should probably be replaced by a
-    /// panic!() or unreachable!()
+    /// `panic!()` or `unreachable!()`
     ///
     /// **Known problems:** None
     ///
     /// **Example:**
     /// ```rust,ignore
     /// assert!(false)
-    /// // or
     /// assert!(true)
-    /// // or
     /// const B: bool = false;
     /// assert!(B)
     /// ```
diff --git a/clippy_lints/src/block_in_if_condition.rs b/clippy_lints/src/block_in_if_condition.rs
index 56b4e5522f4..50c1262f2d6 100644
--- a/clippy_lints/src/block_in_if_condition.rs
+++ b/clippy_lints/src/block_in_if_condition.rs
@@ -35,7 +35,7 @@ declare_clippy_lint! {
     /// **Known problems:** None.
     ///
     /// **Example:**
-    /// ```ignore
+    /// ```rust,ignore
     /// if { let x = somefunc(); x } {}
     /// // or
     /// if somefunc(|x| { x == 47 }) {}
diff --git a/clippy_lints/src/needless_bool.rs b/clippy_lints/src/needless_bool.rs
index 4c00d15538f..19c22d2b791 100644
--- a/clippy_lints/src/needless_bool.rs
+++ b/clippy_lints/src/needless_bool.rs
@@ -51,7 +51,13 @@ declare_clippy_lint! {
     ///
     /// **Example:**
     /// ```rust,ignore
-    /// if x == true {} // could be `if x { }`
+    /// if x == true {}
+    /// if y == false {}
+    /// ```
+    /// use `x` directly:
+    /// ```rust,ignore
+    /// if x {}
+    /// if !y {}
     /// ```
     pub BOOL_COMPARISON,
     complexity,
diff --git a/clippy_lints/src/swap.rs b/clippy_lints/src/swap.rs
index a1f5dee2a9c..05428f1a31f 100644
--- a/clippy_lints/src/swap.rs
+++ b/clippy_lints/src/swap.rs
@@ -54,7 +54,7 @@ declare_clippy_lint! {
     /// a = b;
     /// b = a;
     /// ```
-    /// Could be written as:
+    /// If swapping is intended, use `swap()` instead:
     /// ```rust
     /// # let mut a = 1;
     /// # let mut b = 2;
diff --git a/clippy_lints/src/types.rs b/clippy_lints/src/types.rs
index 26d425cf241..d466924dc68 100644
--- a/clippy_lints/src/types.rs
+++ b/clippy_lints/src/types.rs
@@ -1642,7 +1642,7 @@ declare_clippy_lint! {
     /// **Example:**
     ///
     /// ```rust
-    /// let vec: Vec<isize> = vec![];
+    /// let vec: Vec<isize> = Vec::new();
     /// if vec.len() <= 0 {}
     /// if 100 > std::i32::MAX {}
     /// ```