Auto merge of #3946 - rchaser53:issue-3920, r=flip1995

[rust.git] / clippy_lints / src / assertions_on_constants.rs

diff --git a/clippy_lints/src/assertions_on_constants.rs b/clippy_lints/src/assertions_on_constants.rs
index 8d366034ba54f5b382ca2454a66f0efe3abd25f2..9e2a8c451ee1e24fa95c8e10975b02bfe33d6dd9 100644 (file)
--- a/clippy_lints/src/assertions_on_constants.rs
+++ b/clippy_lints/src/assertions_on_constants.rs
@@ -1,13 +1,14 @@
+use if_chain::if_chain;
+use rustc::hir::{Expr, ExprKind};
+use rustc::lint::{LateContext, LateLintPass, LintArray, LintPass};
+use rustc::{declare_tool_lint, lint_array};
+
 use crate::consts::{constant, Constant};
-use crate::rustc::hir::{Expr, ExprKind};
-use crate::rustc::lint::{LateContext, LateLintPass, LintArray, LintPass};
-use crate::rustc::{declare_tool_lint, lint_array};
 use crate::syntax::ast::LitKind;
 use crate::utils::{in_macro, is_direct_expn_of, span_help_and_lint};
-use if_chain::if_chain;
 
 declare_clippy_lint! {
-    /// **What it does:** Check to call assert!(true/false)
+    /// **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!()
@@ -15,17 +16,17 @@
     /// **Known problems:** None
     ///
     /// **Example:**
-    /// ```no_run
-    /// assert!(false);
+    /// ```rust,ignore
+    /// assert!(false)
     /// // or
-    /// assert!(true);
+    /// assert!(true)
     /// // or
     /// const B: bool = false;
-    /// assert!(B);
+    /// assert!(B)
     /// ```
     pub ASSERTIONS_ON_CONSTANTS,
     style,
-    "assert!(true/false) will be optimized out by the compiler/should probably be replaced by a panic!() or unreachable!()"
+    "`assert!(true)` / `assert!(false)` will be optimized out by the compiler, and should probably be replaced by a `panic!()` or `unreachable!()`"
 }
 
 pub struct AssertionsOnConstants;