Skip to content

Commit

Permalink
[ allow_attributes_without_reason ]: fix doc nits
Browse files Browse the repository at this point in the history
  • Loading branch information
bitfield committed May 25, 2024
1 parent f491f74 commit 0c83502
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions clippy_lints/src/attrs/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -305,13 +305,16 @@ declare_clippy_lint! {

declare_clippy_lint! {
/// ### What it does
/// Checks for attributes that allow lints without a reason.
/// Checks for attributes that allow lints without specifying the reason
/// they should be allowed.
///
/// (This requires the `lint_reasons` feature)
/// (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
Expand Down

0 comments on commit 0c83502

Please sign in to comment.