Skip to content

Commit ec4eff6

Browse files
committed
Update readme description of restriction lints to dissuade casual use.
1 parent 5ef3cc8 commit ec4eff6

File tree

1 file changed

+21
-11
lines changed

1 file changed

+21
-11
lines changed

README.md

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19,21 +19,28 @@ You can choose how much Clippy is supposed to ~~annoy~~ help you by changing the
1919
| `clippy::complexity` | code that does something simple but in a complex way | **warn** |
2020
| `clippy::perf` | code that can be written to run faster | **warn** |
2121
| `clippy::pedantic` | lints which are rather strict or have occasional false positives | allow |
22+
| `clippy::restriction` | lints which prevent the use of language and library features[^restrict] | allow |
2223
| `clippy::nursery` | new lints that are still under development | allow |
2324
| `clippy::cargo` | lints for the cargo manifest | allow |
2425

2526
More to come, please [file an issue](https://github.com/rust-lang/rust-clippy/issues) if you have ideas!
2627

27-
The [lint list](https://rust-lang.github.io/rust-clippy/master/index.html) also contains "restriction lints", which are
28-
for things which are usually not considered "bad", but may be useful to turn on in specific cases. These should be used
29-
very selectively, if at all.
28+
The `restriction` category should, *emphatically*, not be enabled as a whole. The contained lints may lint against perfectly reasonable code, may not have an alternative suggestion, and may contradict any other lints (including other categories). Lints should be considered on a case-by-case basis before enabling.
29+
30+
[^restrict]: Some use cases for `restriction` lints include:
31+
32+
* Strict coding styles.
33+
* Additional restrictions on CI (e.g. `clippy::todo`).
34+
* Preventing panicking in certain functions (e.g. `#[forbid(clippy::unwrap_used)]` on a module or function).
35+
36+
---
3037

3138
Table of contents:
3239

33-
* [Usage instructions](#usage)
34-
* [Configuration](#configuration)
35-
* [Contributing](#contributing)
36-
* [License](#license)
40+
* [Usage instructions](#usage)
41+
* [Configuration](#configuration)
42+
* [Contributing](#contributing)
43+
* [License](#license)
3744

3845
## Usage
3946

@@ -64,6 +71,7 @@ Once you have rustup and the latest stable release (at least Rust 1.29) installe
6471
```terminal
6572
rustup component add clippy
6673
```
74+
6775
If it says that it can't find the `clippy` component, please run `rustup self update`.
6876

6977
#### Step 3: Run Clippy
@@ -143,16 +151,16 @@ line. (You can swap `clippy::all` with the specific lint category you are target
143151

144152
You can add options to your code to `allow`/`warn`/`deny` Clippy lints:
145153

146-
* the whole set of `Warn` lints using the `clippy` lint group (`#![deny(clippy::all)]`).
154+
* the whole set of `Warn` lints using the `clippy` lint group (`#![deny(clippy::all)]`).
147155
Note that `rustc` has additional [lint groups](https://doc.rust-lang.org/rustc/lints/groups.html).
148156

149-
* all lints using both the `clippy` and `clippy::pedantic` lint groups (`#![deny(clippy::all)]`,
157+
* all lints using both the `clippy` and `clippy::pedantic` lint groups (`#![deny(clippy::all)]`,
150158
`#![deny(clippy::pedantic)]`). Note that `clippy::pedantic` contains some very aggressive
151159
lints prone to false positives.
152160

153-
* only some lints (`#![deny(clippy::single_match, clippy::box_vec)]`, etc.)
161+
* only some lints (`#![deny(clippy::single_match, clippy::box_vec)]`, etc.)
154162

155-
* `allow`/`warn`/`deny` can be limited to a single function or module using `#[allow(...)]`, etc.
163+
* `allow`/`warn`/`deny` can be limited to a single function or module using `#[allow(...)]`, etc.
156164

157165
Note: `allow` means to suppress the lint for your code. With `warn` the lint
158166
will only emit a warning, while with `deny` the lint will emit an error, when
@@ -176,12 +184,14 @@ cargo clippy -- -W clippy::lint_name
176184

177185
This also works with lint groups. For example, you
178186
can run Clippy with warnings for all lints enabled:
187+
179188
```terminal
180189
cargo clippy -- -W clippy::pedantic
181190
```
182191

183192
If you care only about a single lint, you can allow all others and then explicitly warn on
184193
the lint(s) you are interested in:
194+
185195
```terminal
186196
cargo clippy -- -A clippy::all -W clippy::useless_format -W clippy::...
187197
```

0 commit comments

Comments
 (0)