@@ -6,21 +6,21 @@ use rustc_session::{declare_tool_lint, impl_lint_pass};
66use rustc_span:: source_map:: Span ;
77
88declare_clippy_lint ! {
9- /// **What it does:** Checks for integer arithmetic operations which could overflow or panic.
9+ /// ### What it does
10+ /// Checks for integer arithmetic operations which could overflow or panic.
1011 ///
1112 /// Specifically, checks for any operators (`+`, `-`, `*`, `<<`, etc) which are capable
1213 /// of overflowing according to the [Rust
1314 /// Reference](https://doc.rust-lang.org/reference/expressions/operator-expr.html#overflow),
1415 /// or which can panic (`/`, `%`). No bounds analysis or sophisticated reasoning is
1516 /// attempted.
1617 ///
17- /// **Why is this bad?** Integer overflow will trigger a panic in debug builds or will wrap in
18+ /// ### Why is this bad?
19+ /// Integer overflow will trigger a panic in debug builds or will wrap in
1820 /// release mode. Division by zero will cause a panic in either mode. In some applications one
1921 /// wants explicitly checked, wrapping or saturating arithmetic.
2022 ///
21- /// **Known problems:** None.
22- ///
23- /// **Example:**
23+ /// ### Example
2424 /// ```rust
2525 /// # let a = 0;
2626 /// a + 1;
@@ -31,14 +31,14 @@ declare_clippy_lint! {
3131}
3232
3333declare_clippy_lint ! {
34- /// **What it does:** Checks for float arithmetic.
34+ /// ### What it does
35+ /// Checks for float arithmetic.
3536 ///
36- /// **Why is this bad?** For some embedded systems or kernel development, it
37+ /// ### Why is this bad?
38+ /// For some embedded systems or kernel development, it
3739 /// can be useful to rule out floating-point numbers.
3840 ///
39- /// **Known problems:** None.
40- ///
41- /// **Example:**
41+ /// ### Example
4242 /// ```rust
4343 /// # let a = 0.0;
4444 /// a + 1.0;
0 commit comments