summaryrefslogtreecommitdiffstats
path: root/src/tools/clippy/src/docs/similar_names.txt
diff options
context:
space:
mode:
Diffstat (limited to 'src/tools/clippy/src/docs/similar_names.txt')
-rw-r--r--src/tools/clippy/src/docs/similar_names.txt4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/tools/clippy/src/docs/similar_names.txt b/src/tools/clippy/src/docs/similar_names.txt
index 13aca9c0b..f9eff21b6 100644
--- a/src/tools/clippy/src/docs/similar_names.txt
+++ b/src/tools/clippy/src/docs/similar_names.txt
@@ -1,6 +1,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.