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

Clarify allow/warn/deny. Remove enable/disable.

Browse source 
Disable and enable when not specifically explained were not clear to me
as an English language speaker, but I was able to figure it out fairly
easily due to the examples having A/W, which I assumed meant `allow` and
`warn`.  I removed both words to be sure it was clear as well as
extending the note on what deny means.  It now includes a statement on
exactly what each word means.
This commit is contained in:
Randall Mason 2020-10-30 12:16:11 -05:00
parent 0be654482c
commit 9f402c991b
1 changed files with 10 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -167,18 +167,22 @@ You can add options to your code to `allow`/`warn`/`deny` Clippy lints:
* `allow`/`warn`/`deny` can be limited to a single function or module using `#[allow(...)]`, etc.
Note: `deny` produces errors instead of warnings.
Note: `allow` in this case means to "allow your code to have the lint without
warning". `deny` means "produce an error if your code has the lint". `warn`
means "produce a warning, but don't produce an error due to this lint". An
error causes clippy to exit with an error code, so is useful in scripts like
CI/CD.
If you do not want to include your lint levels in your code, you can globally enable/disable lints
by passing extra flags to Clippy during the run:
If you do not want to include your lint levels in your code, you can globally
enable/disable lints by passing extra flags to Clippy during the run:
To disable `lint_name`, run
To allow `lint_name`, run
```terminal
cargo clippy -- -A clippy::lint_name
```
And to enable `lint_name`, run
And to warn on `lint_name`, run
```terminal
cargo clippy -- -W clippy::lint_name
@ -190,7 +194,7 @@ can run Clippy with warnings for all lints enabled:
cargo clippy -- -W clippy::pedantic
```
If you care only about a single lint, you can allow all others and then explicitly reenable
If you care only about a single lint, you can allow all others and then explicitly warn on
the lint(s) you are interested in:
```terminal
cargo clippy -- -A clippy::all -W clippy::useless_format -W clippy::...