From a18d8bfa7d71163ea18359176cdf7aa01880b856 Mon Sep 17 00:00:00 2001 From: InSync Date: Sat, 8 Mar 2025 02:49:08 +0700 Subject: [PATCH] [`pep8-naming`] Add links to `ignore-names` options in various rules' documentation (#16557) ## Summary Resolves #16551. All rules using [`lint.pep8-naming.ignore-names`](https://docs.astral.sh/ruff/settings/#lint_pep8-naming_ignore-names) and [`lint.pep8-naming.extend-ignore-names`](https://docs.astral.sh/ruff/settings/#lint_pep8-naming_extend-ignore-names) now have their documentation linked to these two options. ## Test Plan None. --- .../rules/pep8_naming/rules/camelcase_imported_as_acronym.rs | 2 ++ .../rules/pep8_naming/rules/camelcase_imported_as_constant.rs | 4 ++++ .../pep8_naming/rules/camelcase_imported_as_lowercase.rs | 4 ++++ .../pep8_naming/rules/constant_imported_as_non_constant.rs | 4 ++++ .../src/rules/pep8_naming/rules/dunder_function_name.rs | 4 ++++ .../rules/pep8_naming/rules/error_suffix_on_exception_name.rs | 4 ++++ .../src/rules/pep8_naming/rules/invalid_argument_name.rs | 4 ++++ .../src/rules/pep8_naming/rules/invalid_class_name.rs | 4 ++++ .../pep8_naming/rules/lowercase_imported_as_non_lowercase.rs | 4 ++++ .../pep8_naming/rules/mixed_case_variable_in_class_scope.rs | 4 ++++ .../pep8_naming/rules/mixed_case_variable_in_global_scope.rs | 4 ++++ 11 files changed, 42 insertions(+) diff --git a/crates/ruff_linter/src/rules/pep8_naming/rules/camelcase_imported_as_acronym.rs b/crates/ruff_linter/src/rules/pep8_naming/rules/camelcase_imported_as_acronym.rs index 7d3487a707..14400d905f 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/rules/camelcase_imported_as_acronym.rs +++ b/crates/ruff_linter/src/rules/pep8_naming/rules/camelcase_imported_as_acronym.rs @@ -37,6 +37,8 @@ use crate::rules::pep8_naming::helpers; /// /// ## Options /// - `lint.flake8-import-conventions.aliases` +/// - `lint.pep8-naming.ignore-names` +/// - `lint.pep8-naming.extend-ignore-names` /// /// [PEP 8]: https://peps.python.org/pep-0008/ #[derive(ViolationMetadata)] diff --git a/crates/ruff_linter/src/rules/pep8_naming/rules/camelcase_imported_as_constant.rs b/crates/ruff_linter/src/rules/pep8_naming/rules/camelcase_imported_as_constant.rs index a85da27429..c2b27f2c8c 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/rules/camelcase_imported_as_constant.rs +++ b/crates/ruff_linter/src/rules/pep8_naming/rules/camelcase_imported_as_constant.rs @@ -44,6 +44,10 @@ use crate::rules::pep8_naming::settings::IgnoreNames; /// A common example of a single uppercase character being used for a class /// name can be found in Django's `django.db.models.Q` class. /// +/// ## Options +/// - `lint.pep8-naming.ignore-names` +/// - `lint.pep8-naming.extend-ignore-names` +/// /// [PEP 8]: https://peps.python.org/pep-0008/ #[derive(ViolationMetadata)] pub(crate) struct CamelcaseImportedAsConstant { diff --git a/crates/ruff_linter/src/rules/pep8_naming/rules/camelcase_imported_as_lowercase.rs b/crates/ruff_linter/src/rules/pep8_naming/rules/camelcase_imported_as_lowercase.rs index 0ed58bc0aa..e883c1ed57 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/rules/camelcase_imported_as_lowercase.rs +++ b/crates/ruff_linter/src/rules/pep8_naming/rules/camelcase_imported_as_lowercase.rs @@ -29,6 +29,10 @@ use crate::rules::pep8_naming::settings::IgnoreNames; /// from example import MyClassName /// ``` /// +/// ## Options +/// - `lint.pep8-naming.ignore-names` +/// - `lint.pep8-naming.extend-ignore-names` +/// /// [PEP 8]: https://peps.python.org/pep-0008/ #[derive(ViolationMetadata)] pub(crate) struct CamelcaseImportedAsLowercase { diff --git a/crates/ruff_linter/src/rules/pep8_naming/rules/constant_imported_as_non_constant.rs b/crates/ruff_linter/src/rules/pep8_naming/rules/constant_imported_as_non_constant.rs index 30474843a6..d2f8adf0f4 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/rules/constant_imported_as_non_constant.rs +++ b/crates/ruff_linter/src/rules/pep8_naming/rules/constant_imported_as_non_constant.rs @@ -42,6 +42,10 @@ use crate::rules::pep8_naming::{helpers, settings::IgnoreNames}; /// A common example of a single uppercase character being used for a class /// name can be found in Django's `django.db.models.Q` class. /// +/// ## Options +/// - `lint.pep8-naming.ignore-names` +/// - `lint.pep8-naming.extend-ignore-names` +/// /// [PEP 8]: https://peps.python.org/pep-0008/ #[derive(ViolationMetadata)] pub(crate) struct ConstantImportedAsNonConstant { diff --git a/crates/ruff_linter/src/rules/pep8_naming/rules/dunder_function_name.rs b/crates/ruff_linter/src/rules/pep8_naming/rules/dunder_function_name.rs index c2d2d92a79..2b5ae74493 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/rules/dunder_function_name.rs +++ b/crates/ruff_linter/src/rules/pep8_naming/rules/dunder_function_name.rs @@ -31,6 +31,10 @@ use crate::rules::pep8_naming::settings::IgnoreNames; /// pass /// ``` /// +/// ## Options +/// - `lint.pep8-naming.ignore-names` +/// - `lint.pep8-naming.extend-ignore-names` +/// /// [PEP 8]: https://peps.python.org/pep-0008/ #[derive(ViolationMetadata)] pub(crate) struct DunderFunctionName; diff --git a/crates/ruff_linter/src/rules/pep8_naming/rules/error_suffix_on_exception_name.rs b/crates/ruff_linter/src/rules/pep8_naming/rules/error_suffix_on_exception_name.rs index ecec6e610e..fcb85ba6cf 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/rules/error_suffix_on_exception_name.rs +++ b/crates/ruff_linter/src/rules/pep8_naming/rules/error_suffix_on_exception_name.rs @@ -28,6 +28,10 @@ use crate::rules::pep8_naming::settings::IgnoreNames; /// class ValidationError(Exception): ... /// ``` /// +/// ## Options +/// - `lint.pep8-naming.ignore-names` +/// - `lint.pep8-naming.extend-ignore-names` +/// /// [PEP 8]: https://peps.python.org/pep-0008/#exception-names #[derive(ViolationMetadata)] pub(crate) struct ErrorSuffixOnExceptionName { diff --git a/crates/ruff_linter/src/rules/pep8_naming/rules/invalid_argument_name.rs b/crates/ruff_linter/src/rules/pep8_naming/rules/invalid_argument_name.rs index 358180802c..dd0a83a9a3 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/rules/invalid_argument_name.rs +++ b/crates/ruff_linter/src/rules/pep8_naming/rules/invalid_argument_name.rs @@ -37,6 +37,10 @@ use crate::checkers::ast::Checker; /// pass /// ``` /// +/// ## Options +/// - `lint.pep8-naming.ignore-names` +/// - `lint.pep8-naming.extend-ignore-names` +/// /// [PEP 8]: https://peps.python.org/pep-0008/#function-and-method-arguments /// [preview]: https://docs.astral.sh/ruff/preview/ #[derive(ViolationMetadata)] diff --git a/crates/ruff_linter/src/rules/pep8_naming/rules/invalid_class_name.rs b/crates/ruff_linter/src/rules/pep8_naming/rules/invalid_class_name.rs index c6f6166677..b755667918 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/rules/invalid_class_name.rs +++ b/crates/ruff_linter/src/rules/pep8_naming/rules/invalid_class_name.rs @@ -34,6 +34,10 @@ use crate::rules::pep8_naming::settings::IgnoreNames; /// pass /// ``` /// +/// ## Options +/// - `lint.pep8-naming.ignore-names` +/// - `lint.pep8-naming.extend-ignore-names` +/// /// [PEP 8]: https://peps.python.org/pep-0008/#class-names #[derive(ViolationMetadata)] pub(crate) struct InvalidClassName { diff --git a/crates/ruff_linter/src/rules/pep8_naming/rules/lowercase_imported_as_non_lowercase.rs b/crates/ruff_linter/src/rules/pep8_naming/rules/lowercase_imported_as_non_lowercase.rs index c7fc24d3c8..83262dac4a 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/rules/lowercase_imported_as_non_lowercase.rs +++ b/crates/ruff_linter/src/rules/pep8_naming/rules/lowercase_imported_as_non_lowercase.rs @@ -28,6 +28,10 @@ use crate::rules::pep8_naming::settings::IgnoreNames; /// from example import myclassname /// ``` /// +/// ## Options +/// - `lint.pep8-naming.ignore-names` +/// - `lint.pep8-naming.extend-ignore-names` +/// /// [PEP 8]: https://peps.python.org/pep-0008/ #[derive(ViolationMetadata)] pub(crate) struct LowercaseImportedAsNonLowercase { diff --git a/crates/ruff_linter/src/rules/pep8_naming/rules/mixed_case_variable_in_class_scope.rs b/crates/ruff_linter/src/rules/pep8_naming/rules/mixed_case_variable_in_class_scope.rs index f7a7614a85..905bcb47d4 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/rules/mixed_case_variable_in_class_scope.rs +++ b/crates/ruff_linter/src/rules/pep8_naming/rules/mixed_case_variable_in_class_scope.rs @@ -35,6 +35,10 @@ use crate::rules::pep8_naming::helpers; /// another_variable = "world" /// ``` /// +/// ## Options +/// - `lint.pep8-naming.ignore-names` +/// - `lint.pep8-naming.extend-ignore-names` +/// /// [PEP 8]: https://peps.python.org/pep-0008/#function-and-method-arguments #[derive(ViolationMetadata)] pub(crate) struct MixedCaseVariableInClassScope { diff --git a/crates/ruff_linter/src/rules/pep8_naming/rules/mixed_case_variable_in_global_scope.rs b/crates/ruff_linter/src/rules/pep8_naming/rules/mixed_case_variable_in_global_scope.rs index 3463617afd..ddaff4e510 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/rules/mixed_case_variable_in_global_scope.rs +++ b/crates/ruff_linter/src/rules/pep8_naming/rules/mixed_case_variable_in_global_scope.rs @@ -46,6 +46,10 @@ use crate::rules::pep8_naming::helpers; /// yet_another_variable = "foo" /// ``` /// +/// ## Options +/// - `lint.pep8-naming.ignore-names` +/// - `lint.pep8-naming.extend-ignore-names` +/// /// [PEP 8]: https://peps.python.org/pep-0008/#global-variable-names #[derive(ViolationMetadata)] pub(crate) struct MixedCaseVariableInGlobalScope {