about summary refs log tree commit diff
diff options
context:
space:
mode:
authorMatthias Krüger <matthias.krueger@famsik.de>2022-09-22 21:34:51 +0200
committerGitHub <noreply@github.com>2022-09-22 21:34:51 +0200
commit2063b8f1377550cd8a6cb55fee838dcac5cf452e (patch)
tree943916ae14682645e28666eaaa27ee897362f63a
parent4d015293d1cb7ebdd0972e620c3e0f1763ad2ec8 (diff)
parent09b1e8ff3494a6fa92922ef992fb8fe861c87b28 (diff)
downloadrust-2063b8f1377550cd8a6cb55fee838dcac5cf452e.tar.gz
rust-2063b8f1377550cd8a6cb55fee838dcac5cf452e.zip
Rollup merge of #102123 - schteve:clippy-note, r=Manishearth
Add note to clippy::non_expressive_names doc

Addresses confusion in rust-lang/rust-clippy#9514 by updating the lint docs.
-rw-r--r--clippy_lints/src/non_expressive_names.rs4
1 files changed, 4 insertions, 0 deletions
diff --git a/clippy_lints/src/non_expressive_names.rs b/clippy_lints/src/non_expressive_names.rs
index b96af06b8d7..a7cd1f6d065 100644
--- a/clippy_lints/src/non_expressive_names.rs
+++ b/clippy_lints/src/non_expressive_names.rs
@@ -15,6 +15,10 @@ declare_clippy_lint! {
     /// ### 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.