[flake8-import-conventions] Add links to options (#8115)

astral-sh · Oct 22, 2023 · 66e6388 · 66e6388
1 parent 8472a7e
commit 66e6388
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 0 deletions.
diff --git a/crates/ruff_linter/src/rules/flake8_import_conventions/rules/banned_import_alias.rs b/crates/ruff_linter/src/rules/flake8_import_conventions/rules/banned_import_alias.rs
@@ -27,6 +27,9 @@ use ruff_text_size::Ranged;
 ///
 /// tf.keras.backend
 /// ```
+///
+/// ## Options
+/// - `flake8-import-conventions.banned-aliases`
 #[violation]
 pub struct BannedImportAlias {
     name: String,

diff --git a/crates/ruff_linter/src/rules/flake8_import_conventions/rules/banned_import_from.rs b/crates/ruff_linter/src/rules/flake8_import_conventions/rules/banned_import_from.rs
@@ -28,6 +28,9 @@ use ruff_text_size::Ranged;
 ///
 /// pd.Series
 /// ```
+///
+/// ## Options
+/// - `flake8-import-conventions.banned-from`
 #[violation]
 pub struct BannedImportFrom {
     name: String,

diff --git a/crates/ruff_linter/src/rules/flake8_import_conventions/rules/unconventional_import_alias.rs b/crates/ruff_linter/src/rules/flake8_import_conventions/rules/unconventional_import_alias.rs
@@ -30,6 +30,10 @@ use crate::renamer::Renamer;
 /// ```python
 /// import pandas as pd
 /// ```
+///
+/// ## Options
+/// - `flake8-import-conventions.aliases`
+/// - `flake8-import-conventions.extend-aliases`
 #[violation]
 pub struct UnconventionalImportAlias {
     name: String,