about summary refs log tree commit diff
diff options
context:
space:
mode:
authorLotte Steenbrink <lotte.steenbrink@ferrous-systems.com>2020-10-14 11:58:22 +0200
committerLotte Steenbrink <lotte.steenbrink@ferrous-systems.com>2020-10-14 16:45:36 +0200
commit8ba18aeb6963d70767a0880ecb7929864fe14ef9 (patch)
treef9a8a16ffb999cd015b675994011337ceb8f035b
parent0b77c359652846decf3d735bd246166e921105c6 (diff)
downloadrust-8ba18aeb6963d70767a0880ecb7929864fe14ef9.tar.gz
rust-8ba18aeb6963d70767a0880ecb7929864fe14ef9.zip
README: sort en/disabling section, fix typos, add note
-rw-r--r--README.md31
1 files changed, 26 insertions, 5 deletions
diff --git a/README.md b/README.md
index 62a8be0abf2..e1b3c84d691 100644
--- a/README.md
+++ b/README.md
@@ -169,12 +169,33 @@ You can add options to your code to `allow`/`warn`/`deny` Clippy lints:
 
 Note: `deny` produces errors instead of warnings.
 
-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: `cargo clippy -- -A clippy::lint_name` will run Clippy with `lint_name` disabled and
-`cargo clippy -- -W clippy::lint_name` will run it with that enabled. This also works with lint groups. For example you
-can run Clippy with warnings for all lints enabled: `cargo clippy -- -W clippy::pedantic`
+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
+
+```terminal
+cargo clippy -- -A clippy::lint_name
+```
+
+And to enable `lint_name`, run
+
+```terminal
+cargo clippy -- -W clippy::lint_name
+```
+
+This also works with lint groups. For example you
+can run Clippy with warnings for all lints enabled: 
+```terminal
+cargo clippy -- -W clippy::pedantic
+```
+
 If you care only about a single lint, you can allow all others and then explicitly reenable
-the lint(s) you are interested in: `cargo clippy -- -Aclippy::all -Wclippy::useless_format -Wclippy::...`
+the lint(s) you are interested in:
+```terminal
+cargo clippy -- -A clippy::all -W clippy::useless_format -W clippy::...
+```
+Note that if you've run clippy before, this may only take effect after you've modified a file or ran `cargo clean`.
 
 ## Contributing