diff options
| author | bors <bors@rust-lang.org> | 2020-11-04 08:49:10 +0000 |
|---|---|---|
| committer | bors <bors@rust-lang.org> | 2020-11-04 08:49:10 +0000 |
| commit | 3a34bc017d2e9334ed2ee3513b248003c2d90a5c (patch) | |
| tree | 41ec6563761582090247c87751cee6933ec37702 | |
| parent | 225ce5ff588a500eea636ecb1bd53245e9adc386 (diff) | |
| parent | cf2043d4a255b589f329e0727ef2e3a10e1a401d (diff) | |
| download | rust-3a34bc017d2e9334ed2ee3513b248003c2d90a5c.tar.gz rust-3a34bc017d2e9334ed2ee3513b248003c2d90a5c.zip | |
Auto merge of #6270 - ClashTheBunny:clarify_allow_deny_enable_disable, r=flip1995
Clarify allow/warn/deny documentation. Remove enable/disable. 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. Documentation only update. *Please keep the line below* changelog: none
| -rw-r--r-- | README.md | 15 |
1 files changed, 9 insertions, 6 deletions
diff --git a/README.md b/README.md index e1b3c84d691..8a5975e1f97 100644 --- a/README.md +++ b/README.md @@ -167,18 +167,21 @@ 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` means to suppress the lint for your code. With `warn` the lint +will only emit a warning, while with `deny` the lint will emit an error, when +triggering for your code. 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 +193,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::... |