diff options
| author | John Arundel <john@bitfieldconsulting.com> | 2024-06-03 12:38:25 +0100 |
|---|---|---|
| committer | John Arundel <john@bitfieldconsulting.com> | 2024-06-06 12:45:32 +0100 |
| commit | 8da5d64669c18b52c4edaaf71a739585d97a5767 (patch) | |
| tree | 6d75b5a8e33e5671c21348848adbcb44c837dcd2 | |
| parent | 35d284fcbf947089315beccb6d1af7396d09d5d3 (diff) | |
| download | rust-8da5d64669c18b52c4edaaf71a739585d97a5767.tar.gz rust-8da5d64669c18b52c4edaaf71a739585d97a5767.zip | |
[ allow_attributes_without_reason ]: fix doc nits
| -rw-r--r-- | clippy_lints/src/attrs/mod.rs | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/clippy_lints/src/attrs/mod.rs b/clippy_lints/src/attrs/mod.rs index 83c828e8e22..bd10ebbe5f5 100644 --- a/clippy_lints/src/attrs/mod.rs +++ b/clippy_lints/src/attrs/mod.rs @@ -270,13 +270,14 @@ declare_clippy_lint! { declare_clippy_lint! { /// ### What it does - /// Checks for attributes that allow lints without a reason. - /// - /// (This requires the `lint_reasons` feature) + /// Checks for attributes that allow lints without specifying the reason + /// they should be allowed. (This requires the `lint_reasons` feature.) /// /// ### Why restrict this? - /// Justifying each `allow` helps readers understand the reasoning, - /// and may allow removing `allow` attributes if their purpose is obsolete. + /// There should always be a specific reason to allow a lint. This reason + /// should be documented using the `reason` parameter, so that readers can + /// understand why the `allow` is required, or remove it if it's no + /// longer needed. /// /// ### Example /// ```no_run |
