about summary refs log tree commit diff
diff options
context:
space:
mode:
authorPhilipp Krones <hello@philkrones.com>2025-02-06 09:23:22 +0000
committerGitHub <noreply@github.com>2025-02-06 09:23:22 +0000
commitee1c15eb5659d9d5a801c51202d6dbd1131704ed (patch)
tree07f345b7642ff0b75ed2cb7260a1de1839610f49
parentf09701ab6acb6db235317c8ed73bb6e923814f35 (diff)
parentc718ae8e2d4692ac3e17278a46557a15c4ed0992 (diff)
downloadrust-ee1c15eb5659d9d5a801c51202d6dbd1131704ed.tar.gz
rust-ee1c15eb5659d9d5a801c51202d6dbd1131704ed.zip
Add Nursery and Deprecated groups section at Book (#13926)
[RFC](https://github.com/rust-lang/rfcs/blob/master/text/2476-clippy-uno.md#lint-audit-and-categories)
has more groups so add them

changelog: none
-rw-r--r--book/src/lints.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/book/src/lints.md b/book/src/lints.md
index 442dc63914e..1dd51797660 100644
--- a/book/src/lints.md
+++ b/book/src/lints.md
@@ -101,5 +101,18 @@ The `clippy::cargo` group gives you suggestions on how to improve your
 your crate and are not sure if you have all useful information in your
 `Cargo.toml`.
 
+## Nursery
+
+The `clippy::nursery` group contains lints which are buggy or need more work. It is **not** 
+recommended to enable the whole group, but rather cherry-pick lints that are useful for your 
+code base and your use case. 
+
+## Deprecated
+
+The `clippy::deprecated` is empty lints that exist to ensure that `#[allow(lintname)]` still 
+compiles after the lint was deprecated. Deprecation "removes" lints by removing their 
+functionality and marking them as deprecated, which may cause further warnings but cannot 
+cause a compiler error.
+
 [Clippy lint documentation]: https://rust-lang.github.io/rust-clippy/
 [Clippy 1.0 RFC]: https://github.com/rust-lang/rfcs/blob/master/text/2476-clippy-uno.md#lint-audit-and-categories