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/missing_inline.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/missing_inline.rs')
| -rw-r--r-- | clippy_lints/src/missing_inline.rs | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/clippy_lints/src/missing_inline.rs b/clippy_lints/src/missing_inline.rs index 041fe64a1a9..be5b4b4006f 100644 --- a/clippy_lints/src/missing_inline.rs +++ b/clippy_lints/src/missing_inline.rs @@ -7,10 +7,12 @@ use rustc_span::source_map::Span; use rustc_span::sym; declare_clippy_lint! { - /// **What it does:** it lints if an exported function, method, trait method with default impl, + /// ### What it does + /// it lints if an exported function, method, trait method with default impl, /// or trait method impl is not `#[inline]`. /// - /// **Why is this bad?** In general, it is not. Functions can be inlined across + /// ### Why is this bad? + /// In general, it is not. Functions can be inlined across /// crates when that's profitable as long as any form of LTO is used. When LTO is disabled, /// functions that are not `#[inline]` cannot be inlined across crates. Certain types of crates /// might intend for most of the methods in their public API to be able to be inlined across @@ -18,9 +20,7 @@ declare_clippy_lint! { /// sense. It allows the crate to require all exported methods to be `#[inline]` by default, and /// then opt out for specific methods where this might not make sense. /// - /// **Known problems:** None. - /// - /// **Example:** + /// ### Example /// ```rust /// pub fn foo() {} // missing #[inline] /// fn ok() {} // ok |
