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.txt12
1 files changed, 12 insertions, 0 deletions
diff --git a/src/tools/clippy/src/docs/similar_names.txt b/src/tools/clippy/src/docs/similar_names.txt
new file mode 100644
index 000000000..13aca9c0b
--- /dev/null
+++ b/src/tools/clippy/src/docs/similar_names.txt
@@ -0,0 +1,12 @@
+### What it does
+Checks for names that are very similar and thus confusing.
+
+### Why is this bad?
+It's hard to distinguish between names that differ only
+by a single character.
+
+### Example
+```
+let checked_exp = something;
+let checked_expr = something_else;
+``` \ No newline at end of file