Improvement documentation around ignore-names globbing (#7674)

## Summary

Improves the documentation on the setting itself, along with that on the
relevant rules.

Closes https://github.com/astral-sh/ruff/issues/7660.

crates/ruff_linter/src/rules/pep8_naming/rules/invalid_first_argument_name_for_class_method.rs

@@ -22,6 +22,11 @@ use crate::checkers::ast::Checker;
 /// > append a single trailing underscore rather than use an abbreviation or spelling corruption.
 /// > Thus `class_` is better than `clss`. (Perhaps better is to avoid such clashes by using a synonym.)
 ///
+/// Names can be excluded from this rule using the [`pep8-naming.ignore-names`]
+/// or [`pep8-naming.extend-ignore-names`] configuration options. For example,
+/// to allow the use of `klass` as the first argument to class methods, set
+/// the [`pep8-naming.extend-ignore-names`] option to `["klass"]`.
+///
 /// ## Example
 /// ```python
 /// class Example:
@@ -42,6 +47,7 @@ use crate::checkers::ast::Checker;
 /// - `pep8-naming.classmethod-decorators`
 /// - `pep8-naming.staticmethod-decorators`
 /// - `pep8-naming.ignore-names`
+/// - `pep8-naming.extend-ignore-names`
 ///
 /// [PEP 8]: https://peps.python.org/pep-0008/#function-and-method-arguments
 #[violation]

crates/ruff_linter/src/rules/pep8_naming/rules/invalid_first_argument_name_for_method.rs

@@ -22,6 +22,11 @@ use crate::checkers::ast::Checker;
 /// > append a single trailing underscore rather than use an abbreviation or spelling corruption.
 /// > Thus `class_` is better than `clss`. (Perhaps better is to avoid such clashes by using a synonym.)
 ///
+/// Names can be excluded from this rule using the [`pep8-naming.ignore-names`]
+/// or [`pep8-naming.extend-ignore-names`] configuration options. For example,
+/// to allow the use of `this` as the first argument to instance methods, set
+/// the [`pep8-naming.extend-ignore-names`] option to `["this"]`.
+///
 /// ## Example
 /// ```python
 /// class Example:
@@ -40,6 +45,7 @@ use crate::checkers::ast::Checker;
 /// - `pep8-naming.classmethod-decorators`
 /// - `pep8-naming.staticmethod-decorators`
 /// - `pep8-naming.ignore-names`
+/// - `pep8-naming.extend-ignore-names`
 ///
 /// [PEP 8]: https://peps.python.org/pep-0008/#function-and-method-arguments
 #[violation]

crates/ruff_linter/src/rules/pep8_naming/rules/invalid_function_name.rs

@@ -20,6 +20,11 @@ use crate::settings::types::IdentifierPattern;
 /// > improve readability. mixedCase is allowed only in contexts where that’s already the
 /// > prevailing style (e.g. threading.py), to retain backwards compatibility.
 ///
+/// Names can be excluded from this rule using the [`pep8-naming.ignore-names`]
+/// or [`pep8-naming.extend-ignore-names`] configuration options. For example,
+/// to ignore all functions starting with `test_` from this rule, set the
+/// [`pep8-naming.extend-ignore-names`] option to `["test_*"]`.
+///
 /// ## Example
 /// ```python
 /// def myFunction():
@@ -34,6 +39,7 @@ use crate::settings::types::IdentifierPattern;
 ///
 /// ## Options
 /// - `pep8-naming.ignore-names`
+/// - `pep8-naming.extend-ignore-names`
 ///
 /// [PEP 8]: https://peps.python.org/pep-0008/#function-and-variable-names
 #[violation]

crates/ruff_linter/src/rules/pep8_naming/rules/non_lowercase_variable_in_function.rs

@@ -35,6 +35,7 @@ use crate::rules::pep8_naming::helpers;
 ///
 /// ## Options
 /// - `pep8-naming.ignore-names`
+/// - `pep8-naming.extend-ignore-names`
 ///
 /// [PEP 8]: https://peps.python.org/pep-0008/#function-and-variable-names
 #[violation]

crates/ruff_workspace/src/options.rs

@@ -2050,6 +2050,10 @@ impl McCabeOptions {
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
 pub struct Pep8NamingOptions {
     /// A list of names (or patterns) to ignore when considering `pep8-naming` violations.
+    ///
+    /// Supports glob patterns. For example, to ignore all names starting with
+    /// or ending with `_test`, you could use `ignore-names = ["test_*", "*_test"]`.
+    /// For more information on the glob syntax, refer to the [`globset` documentation](https://docs.rs/globset/latest/globset/#syntax).
     #[option(
         default = r#"["setUp", "tearDown", "setUpClass", "tearDownClass", "setUpModule", "tearDownModule", "asyncSetUp", "asyncTearDown", "setUpTestData", "failureException", "longMessage", "maxDiff"]"#,
         value_type = "list[str]",
@@ -2060,7 +2064,11 @@ pub struct Pep8NamingOptions {
     pub ignore_names: Option<Vec<String>>,
 
     /// Additional names (or patterns) to ignore when considering `pep8-naming` violations,
-    /// in addition to those included in `ignore-names`.
+    /// in addition to those included in `ignore-names`
+    ///
+    /// Supports glob patterns. For example, to ignore all names starting with
+    /// or ending with `_test`, you could use `ignore-names = ["test_*", "*_test"]`.
+    /// For more information on the glob syntax, refer to the [`globset` documentation](https://docs.rs/globset/latest/globset/#syntax)..
     #[option(
         default = r#"[]"#,
         value_type = "list[str]",
@@ -2074,6 +2082,9 @@ pub struct Pep8NamingOptions {
     ///
     /// For example, Ruff will expect that any method decorated by a decorator
     /// in this list takes a `cls` argument as its first argument.
+    ///
+    /// Expects to receive a list of fully-qualified names (e.g., `pydantic.validator`,
+    /// rather than `validator`).
     #[option(
         default = r#"[]"#,
         value_type = "list[str]",
@@ -2090,12 +2101,15 @@ pub struct Pep8NamingOptions {
     ///
     /// For example, Ruff will expect that any method decorated by a decorator
     /// in this list has no `self` or `cls` argument.
+    ///
+    /// Expects to receive a list of fully-qualified names (e.g., `belay.Device.teardown`,
+    /// rather than `teardown`).
     #[option(
         default = r#"[]"#,
         value_type = "list[str]",
         example = r#"
-            # Allow a shorthand alias, `@stcmthd`, to trigger static method treatment.
-            staticmethod-decorators = ["stcmthd"]
+            # Allow Belay's `@Device.teardown` decorator to trigger static method treatment.
+            staticmethod-decorators = ["belay.Device.teardown"]
         "#
     )]
     pub staticmethod_decorators: Option<Vec<String>>,

ruff.schema.json

@@ -1576,7 +1576,7 @@
       "type": "object",
       "properties": {
         "classmethod-decorators": {
-          "description": "A list of decorators that, when applied to a method, indicate that the method should be treated as a class method (in addition to the builtin `@classmethod`).\n\nFor example, Ruff will expect that any method decorated by a decorator in this list takes a `cls` argument as its first argument.",
+          "description": "A list of decorators that, when applied to a method, indicate that the method should be treated as a class method (in addition to the builtin `@classmethod`).\n\nFor example, Ruff will expect that any method decorated by a decorator in this list takes a `cls` argument as its first argument.\n\nExpects to receive a list of fully-qualified names (e.g., `pydantic.validator`, rather than `validator`).",
           "type": [
             "array",
             "null"
@@ -1586,7 +1586,7 @@
           }
         },
         "extend-ignore-names": {
-          "description": "Additional names (or patterns) to ignore when considering `pep8-naming` violations, in addition to those included in `ignore-names`.",
+          "description": "Additional names (or patterns) to ignore when considering `pep8-naming` violations, in addition to those included in `ignore-names`\n\nSupports glob patterns. For example, to ignore all names starting with or ending with `_test`, you could use `ignore-names = [\"test_*\", \"*_test\"]`. For more information on the glob syntax, refer to the [`globset` documentation](https://docs.rs/globset/latest/globset/#syntax)..",
           "type": [
             "array",
             "null"
@@ -1596,7 +1596,7 @@
           }
         },
         "ignore-names": {
-          "description": "A list of names (or patterns) to ignore when considering `pep8-naming` violations.",
+          "description": "A list of names (or patterns) to ignore when considering `pep8-naming` violations.\n\nSupports glob patterns. For example, to ignore all names starting with or ending with `_test`, you could use `ignore-names = [\"test_*\", \"*_test\"]`. For more information on the glob syntax, refer to the [`globset` documentation](https://docs.rs/globset/latest/globset/#syntax).",
           "type": [
             "array",
             "null"
@@ -1606,7 +1606,7 @@
           }
         },
         "staticmethod-decorators": {
-          "description": "A list of decorators that, when applied to a method, indicate that the method should be treated as a static method (in addition to the builtin `@staticmethod`).\n\nFor example, Ruff will expect that any method decorated by a decorator in this list has no `self` or `cls` argument.",
+          "description": "A list of decorators that, when applied to a method, indicate that the method should be treated as a static method (in addition to the builtin `@staticmethod`).\n\nFor example, Ruff will expect that any method decorated by a decorator in this list has no `self` or `cls` argument.\n\nExpects to receive a list of fully-qualified names (e.g., `belay.Device.teardown`, rather than `teardown`).",
           "type": [
             "array",
             "null"