Add note to clippy::non_expressive_names doc

This commit is contained in:
Steve Heindel 2022-09-21 19:45:57 -04:00
parent 0dc24ca376
commit 09b1e8ff34

View file

@ -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.