Polish missing_enforced_import_renames
documentation
* Fixes a typo in the name of the lint (`enforce-import-renames` instead of `enforced-import-renames`). * Copyedit “Why” paragraph. * Make the example configuration use a multi-line list, since it is not particularly expected that a real project will have *exactly one* rename to enforce (and the old formatting had unbalanced whitespace).
This commit is contained in:
parent
7343db9ce3
commit
b8aab4bd1d
@ -13,21 +13,23 @@ use rustc_span::Symbol;
|
||||
declare_clippy_lint! {
|
||||
/// ### What it does
|
||||
/// Checks for imports that do not rename the item as specified
|
||||
/// in the `enforce-import-renames` config option.
|
||||
/// in the `enforced-import-renames` config option.
|
||||
///
|
||||
/// Note: Even though this lint is warn-by-default, it will only trigger if
|
||||
/// import renames are defined in the clippy.toml file.
|
||||
/// import renames are defined in the `clippy.toml` file.
|
||||
///
|
||||
/// ### Why is this bad?
|
||||
/// Consistency is important, if a project has defined import
|
||||
/// renames they should be followed. More practically, some item names are too
|
||||
/// vague outside of their defining scope this can enforce a more meaningful naming.
|
||||
/// Consistency is important; if a project has defined import renames, then they should be
|
||||
/// followed. More practically, some item names are too vague outside of their defining scope,
|
||||
/// in which case this can enforce a more meaningful naming.
|
||||
///
|
||||
/// ### Example
|
||||
/// An example clippy.toml configuration:
|
||||
/// ```toml
|
||||
/// # clippy.toml
|
||||
/// enforced-import-renames = [ { path = "serde_json::Value", rename = "JsonValue" }]
|
||||
/// enforced-import-renames = [
|
||||
/// { path = "serde_json::Value", rename = "JsonValue" },
|
||||
/// ]
|
||||
/// ```
|
||||
///
|
||||
/// ```rust,ignore
|
||||
|
Loading…
x
Reference in New Issue
Block a user