Skip to content

Commit cf2043d

Browse files
committed
Update wording to avoid code having "lint" metaphor
1 parent 9f402c9 commit cf2043d

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

README.md

+4-5
Original file line numberDiff line numberDiff line change
@@ -167,11 +167,10 @@ You can add options to your code to `allow`/`warn`/`deny` Clippy lints:
167167

168168
* `allow`/`warn`/`deny` can be limited to a single function or module using `#[allow(...)]`, etc.
169169

170-
Note: `allow` in this case means to "allow your code to have the lint without
171-
warning". `deny` means "produce an error if your code has the lint". `warn`
172-
means "produce a warning, but don't produce an error due to this lint". An
173-
error causes clippy to exit with an error code, so is useful in scripts like
174-
CI/CD.
170+
Note: `allow` means to suppress the lint for your code. With `warn` the lint
171+
will only emit a warning, while with `deny` the lint will emit an error, when
172+
triggering for your code. An error causes clippy to exit with an error code, so
173+
is useful in scripts like CI/CD.
175174

176175
If you do not want to include your lint levels in your code, you can globally
177176
enable/disable lints by passing extra flags to Clippy during the run:

0 commit comments

Comments
 (0)