Skip to content

Commit 0c83502

Browse files
committed
[ allow_attributes_without_reason ]: fix doc nits
1 parent f491f74 commit 0c83502

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

clippy_lints/src/attrs/mod.rs

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -305,13 +305,16 @@ declare_clippy_lint! {
305305

306306
declare_clippy_lint! {
307307
/// ### What it does
308-
/// Checks for attributes that allow lints without a reason.
308+
/// Checks for attributes that allow lints without specifying the reason
309+
/// they should be allowed.
309310
///
310-
/// (This requires the `lint_reasons` feature)
311+
/// (This requires the `lint_reasons` feature.)
311312
///
312313
/// ### Why restrict this?
313-
/// Justifying each `allow` helps readers understand the reasoning,
314-
/// and may allow removing `allow` attributes if their purpose is obsolete.
314+
/// There should always be a specific reason to allow a lint. This reason
315+
/// should be documented using the `reason` parameter, so that readers can
316+
/// understand why the `allow` is required, or remove it if it's no
317+
/// longer needed.
315318
///
316319
/// ### Example
317320
/// ```no_run

0 commit comments

Comments
 (0)