From e6611c4830047ec090dd2ea48a1a1005675e39bc Mon Sep 17 00:00:00 2001 From: Diego Palacios <99246556+diego-pm@users.noreply.github.com> Date: Thu, 5 Jan 2023 19:37:25 +0100 Subject: [PATCH] Fix flake8-import-conventions configuration examples (#1660) --- README.md | 4 +++- src/flake8_import_conventions/settings.rs | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8c6cb9f3e0b50..d44b12c82df3c 100644 --- a/README.md +++ b/README.md @@ -2461,9 +2461,10 @@ the `extend_aliases` option. ```toml [tool.ruff.flake8-import-conventions] +[tool.ruff.flake8-import-conventions.aliases] # Declare the default aliases. altair = "alt" -matplotlib.pyplot = "plt" +"matplotlib.pyplot" = "plt" numpy = "np" pandas = "pd" seaborn = "sns" @@ -2484,6 +2485,7 @@ will be added to the `aliases` mapping. ```toml [tool.ruff.flake8-import-conventions] +[tool.ruff.flake8-import-conventions.extend-aliases] # Declare a custom alias for the `matplotlib` module. "dask.dataframe" = "dd" ``` diff --git a/src/flake8_import_conventions/settings.rs b/src/flake8_import_conventions/settings.rs index 75fd85371995c..392864e0dd853 100644 --- a/src/flake8_import_conventions/settings.rs +++ b/src/flake8_import_conventions/settings.rs @@ -29,9 +29,10 @@ pub struct Options { default = r#"{"altair": "alt", "matplotlib.pyplot": "plt", "numpy": "np", "pandas": "pd", "seaborn": "sns"}"#, value_type = "FxHashMap", example = r#" + [tool.ruff.flake8-import-conventions.aliases] # Declare the default aliases. altair = "alt" - matplotlib.pyplot = "plt" + "matplotlib.pyplot" = "plt" numpy = "np" pandas = "pd" seaborn = "sns" @@ -44,6 +45,7 @@ pub struct Options { default = r#"{}"#, value_type = "FxHashMap", example = r#" + [tool.ruff.flake8-import-conventions.extend-aliases] # Declare a custom alias for the `matplotlib` module. "dask.dataframe" = "dd" "#