mirror of
https://github.com/rust-lang/rust-clippy
synced 2024-11-10 15:14:29 +00:00
Add note to clippy::non_expressive_names doc
This commit is contained in:
parent
0dc24ca376
commit
09b1e8ff34
1 changed files with 4 additions and 0 deletions
|
@ -15,6 +15,10 @@ declare_clippy_lint! {
|
||||||
/// ### What it does
|
/// ### What it does
|
||||||
/// Checks for names that are very similar and thus confusing.
|
/// Checks for names that are very similar and thus confusing.
|
||||||
///
|
///
|
||||||
|
/// Note: this lint looks for similar names throughout each
|
||||||
|
/// scope. To allow it, you need to allow it on the scope
|
||||||
|
/// level, not on the name that is reported.
|
||||||
|
///
|
||||||
/// ### Why is this bad?
|
/// ### Why is this bad?
|
||||||
/// It's hard to distinguish between names that differ only
|
/// It's hard to distinguish between names that differ only
|
||||||
/// by a single character.
|
/// by a single character.
|
||||||
|
|
Loading…
Reference in a new issue