diff options
| author | Philipp Krones <hello@philkrones.com> | 2021-07-28 15:06:27 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-07-28 15:06:27 +0200 |
| commit | 464c85c8c1c71feda6e53eb9d8713bfdafaf7d8b (patch) | |
| tree | e58ac96a0819f774260a28ea7c1dcdcca567bee2 /clippy_lints/src/default_numeric_fallback.rs | |
| parent | bcdf147aafc6d1c365487abd88cb0bc1cf5f2e63 (diff) | |
| parent | 9bc5803195f75895614feae27607564da01d100a (diff) | |
| download | rust-464c85c8c1c71feda6e53eb9d8713bfdafaf7d8b.tar.gz rust-464c85c8c1c71feda6e53eb9d8713bfdafaf7d8b.zip | |
Rollup merge of #7420 - xFrednet:7172-update-lint-documentation, r=flip1995
Update lint documentation to use markdown headlines This PR updates all lint documentation to use markdown headlines. It additionally removed the *Known problems* section for lints without any problems. I've double-checked all automatic replacements, but a second pair of eyes is definitely appreciated! I wasn't sure when you wanted to switch to the new metadata collection tomorrow, I therefore prepared this PR today. And that's it this is a standalone PR to keep the other related PRs reviewable. changelog: none r? `@flip1995` cc: #7172 Note: This should be merged with the other metadata collection related PRs.
Diffstat (limited to 'clippy_lints/src/default_numeric_fallback.rs')
| -rw-r--r-- | clippy_lints/src/default_numeric_fallback.rs | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/clippy_lints/src/default_numeric_fallback.rs b/clippy_lints/src/default_numeric_fallback.rs index e719a1b0abf..3f1b7ea6214 100644 --- a/clippy_lints/src/default_numeric_fallback.rs +++ b/clippy_lints/src/default_numeric_fallback.rs @@ -18,7 +18,8 @@ use rustc_session::{declare_lint_pass, declare_tool_lint}; use std::iter; declare_clippy_lint! { - /// **What it does:** Checks for usage of unconstrained numeric literals which may cause default numeric fallback in type + /// ### What it does + /// Checks for usage of unconstrained numeric literals which may cause default numeric fallback in type /// inference. /// /// Default numeric fallback means that if numeric types have not yet been bound to concrete @@ -27,12 +28,14 @@ declare_clippy_lint! { /// /// See [RFC0212](https://github.com/rust-lang/rfcs/blob/master/text/0212-restore-int-fallback.md) for more information about the fallback. /// - /// **Why is this bad?** For those who are very careful about types, default numeric fallback + /// ### Why is this bad? + /// For those who are very careful about types, default numeric fallback /// can be a pitfall that cause unexpected runtime behavior. /// - /// **Known problems:** This lint can only be allowed at the function level or above. + /// ### Known problems + /// This lint can only be allowed at the function level or above. /// - /// **Example:** + /// ### Example /// ```rust /// let i = 10; /// let f = 1.23; |
