add a good example for the approx_const lint

rust-lang · Nov 19, 2019 · c6e6b29 · c6e6b29
1 parent c58a5c6
commit c6e6b29
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/clippy_lints/src/approx_const.rs b/clippy_lints/src/approx_const.rs
@@ -23,7 +23,13 @@ declare_clippy_lint! {
     ///
     /// **Example:**
     /// ```rust
+    /// // Bad
     /// let x = 3.14;
+    /// let y = 1_f64 / x;
+    ///
+    /// // Good
+    /// let x = std::f32::consts::PI;
+    /// let y = std::f64::consts::FRAC_1_PI;
     /// ```
     pub APPROX_CONSTANT,
     correctness,