Add note to clippy::non_expressive_names doc

2022-09-21 19:45:57 -04:00 · 2022-09-21 19:45:57 -04:00 · 09b1e8ff34
commit 09b1e8ff34
parent 0dc24ca376
1 changed files with 4 additions and 0 deletions
--- a/clippy_lints/src/non_expressive_names.rs
+++ b/clippy_lints/src/non_expressive_names.rs
@ -15,6 +15,10 @@
    /// ### What it does
    /// 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?
    /// It's hard to distinguish between names that differ only
    /// by a single character.