Update lint documentation to use markdown headlines

This commit is contained in:
xFrednet
2021-07-02 20:37:11 +02:00
committed by flip1995
parent ac0fd99194
commit 12c61612f7
230 changed files with 2717 additions and 2474 deletions

View File

@@ -73,14 +73,13 @@ use rustc_session::Session;
/// use clippy_lints::declare_clippy_lint;
///
/// declare_clippy_lint! {
/// /// **What it does:** Checks for ... (describe what the lint matches).
/// /// ### What it does
/// /// Checks for ... (describe what the lint matches).
/// ///
/// /// **Why is this bad?** Supply the reason for linting the code.
/// ///
/// /// **Known problems:** None. (Or describe where it could go wrong.)
/// ///
/// /// **Example:**
/// /// ### Why is this bad?
/// /// Supply the reason for linting the code.
/// ///
/// /// ### Example
/// /// ```rust
/// /// // Bad
/// /// Insert a short example of code that triggers the lint