Clippy lints / Restriction
Clippy lint · Restriction · checked with Clippy 0.1.99
clippy::min_ident_chars: Checks for identifiers which consist of a single character (or fewer than the configured threshold). Note: This lint can be very noisy when enabled; it may be desirable to only enable it temporarily
What it meansChecks for identifiers which consist of a single character (or fewer than the configured threshold). Note: This lint can be very noisy when enabled; it may be desirable to only enable it temporarily. It is in the restriction group and off by default.
Does it matter?
To improve readability by requiring that every variable has a name more specific than a single letter can be.
Lints that forbid language features for specific codebases (no unwrap, no indexing...). Off by default; pick them one by one, never the whole group.
How to fix it
Clippy does not fix this one automatically. Change the code by hand:
Flagged
for m in movies {
let title = m.t;
}
Write this instead
for movie in movies {
let title = movie.title;
}
Turn it off, or on
It is off by default. To use it, set it to warn or deny:
Whole crate (Cargo.toml)
[lints.clippy]
min_ident_chars = "warn"In code
#![warn(clippy::min_ident_chars)]One run
cargo clippy -- -W clippy::min-ident-charsThe [lints] table needs Rust 1.74 or newer. In a workspace, put it under [workspace.lints.clippy] and add [lints] workspace = true to each member.
Settings in clippy.toml
allowed-idents-below-min-chars: Allowed names below the minimum allowed characters. The value ".." can be used as part of the list to indicate that the configured values should be appended to the default configuration of Clippy. By default, any configuration will replace the default value.min-ident-chars-lint-trait-impl: Whether to lint idents that have too few chars even when following trait declaration.min-ident-chars-threshold: Minimum chars an ident can have, anything below or equal to this will be linted.
Clippy's own documentation
What it does
Checks for identifiers which consist of a single character (or fewer than the configured threshold).
Note: This lint can be very noisy when enabled; it may be desirable to only enable it temporarily.
Why restrict this?
To improve readability by requiring that every variable has a name more specific than a single letter can be.
Example
for m in movies {
let title = m.t;
}
Use instead:
for movie in movies {
let title = movie.title;
}
Limitations
Trait implementations which use the same function or parameter name as the trait declaration will not be warned about, even if the name is below the configured limit.
Configuration
-
allowed-idents-below-min-chars: Allowed names below the minimum allowed characters. The value".."can be used as part of the list to indicate that the configured values should be appended to the default configuration of Clippy. By default, any configuration will replace the default value.(default:
["i", "j", "x", "y", "z", "w", "n"]) -
min-ident-chars-lint-trait-impl: Whether to lint idents that have too few chars even when following trait declaration.(default:
false) -
min-ident-chars-threshold: Minimum chars an ident can have, anything below or equal to this will be linted.(default:
1)
From the Clippy lint list (0.1.99), part of the Rust project, MIT or Apache-2.0. Official entry.
Related lints
- unwrap_usedChecks for .unwrap() or .unwrap_err() calls on Results and .unwrap() call on Options
- module_name_repetitionsDetects public item names that are prefixed or suffixed by the containing public module’s name
- expect_usedChecks for .expect() or .expect_err() calls on Results and .expect() call on Options
- map_err_ignore`map_err(|_|...` wildcard pattern discards the original error
- map_with_unused_argument_over_rangesmap of a closure that does not depend on its parameter over a range
- mem_forgetChecks for usage of std::mem::forget(t) where t is Drop or has a field that implements Drop
- missing_assert_messageChecks assertions without a custom panic message
- missing_asserts_for_indexingindexing into a slice multiple times without an `assert`
- missing_docs_in_private_itemsWarns if there is missing documentation for any private documentable item
All 847 Clippy lints · Rust compiler errors · Cargo.toml checker
Up next
Related lintclippy::unwrap_usedChecks for .unwrap() or .unwrap_err() calls on Results and .unwrap() call on OptionsRead it next →Did this answer your question?