Mirrors/rust-clippy
2
0
Fork 0
mirror of https://github.com/rust-lang/rust-clippy synced 2024-11-10 07:04:18 +00:00
Code Issues Projects Releases Packages Wiki Activity

Clarify lint groups in readme

Browse source
This commit is contained in:
Manish Goregaokar 2019-02-22 13:26:49 +05:30
parent a5c16e5892
commit 50f1dd6af8
1 changed files with 7 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -11,14 +11,14 @@ A collection of lints to catch common mistakes and improve your [Rust](https://g
We have a bunch of lint categories to allow you to choose how much Clippy is supposed to ~~annoy~~ help you: We have a bunch of lint categories to allow you to choose how much Clippy is supposed to ~~annoy~~ help you:
* `clippy::all` (everything that has no false positives) * `clippy::all` (everything that is on by default: all the categories below except for `nursery`, `pedantic`, and `cargo`)
* `clippy::pedantic` (everything) * **`clippy::correctness`** (code that is just outright wrong or very very useless, causes hard errors by default)
* `clippy::nursery` (new lints that aren't quite ready yet)
* `clippy::style` (code that should be written in a more idiomatic way) * `clippy::style` (code that should be written in a more idiomatic way)
* `clippy::complexity` (code that does something simple but in a complex way) * `clippy::complexity` (code that does something simple but in a complex way)
* `clippy::perf` (code that can be written in a faster way) * `clippy::perf` (code that can be written in a faster way)
* `clippy::cargo` (checks against the cargo manifest) * `clippy::pedantic` (lints which are rather strict, off by default)
* **`clippy::correctness`** (code that is just outright wrong or very very useless) * `clippy::nursery` (new lints that aren't quite ready yet, off by default)
* `clippy::cargo` (checks against the cargo manifest, off by default)
More to come, please [file an issue](https://github.com/rust-lang/rust-clippy/issues) if you have ideas! More to come, please [file an issue](https://github.com/rust-lang/rust-clippy/issues) if you have ideas!
@ -31,6 +31,8 @@ Only the following of those categories are enabled by default:
Other categories need to be enabled in order for their lints to be executed. Other categories need to be enabled in order for their lints to be executed.
The [lint list]](https://rust-lang.github.io/rust-clippy/master/index.html) also contains "restriction lints", which are for things which are usually not considered "bad", but may be useful to turn on in specific cases. These should be used very selectively, if at all.
Table of contents: Table of contents:
* [Usage instructions](#usage) * [Usage instructions](#usage)