diff --git a/doc/user_guide/checkers/features.rst b/doc/user_guide/checkers/features.rst index d4fb243c8d..510d95ec62 100644 --- a/doc/user_guide/checkers/features.rst +++ b/doc/user_guide/checkers/features.rst @@ -106,8 +106,8 @@ Basic checker Messages a try...finally block: the exceptions raised in the try clause will be silently swallowed instead of being re-raised. :break-in-finally (W0137): *'break' discouraged inside 'finally' clause* - Emitted when the `break` keyword is found inside a finally clause. This - will raise a SyntaxWarning starting in Python 3.14. + Emitted when the `break` keyword is found inside a finally clause. This will + raise a SyntaxWarning starting in Python 3.14. :continue-in-finally (W0136): *'continue' discouraged inside 'finally' clause* Emitted when the `continue` keyword is found inside a finally clause. This will raise a SyntaxWarning starting in Python 3.14. @@ -193,7 +193,7 @@ Basic checker Messages :missing-parentheses-for-call-in-test (W0126): *Using a conditional statement with potentially wrong function or method call due to missing parentheses* Emitted when a conditional statement (If or ternary if) seems to wrongly call a function due to missing parentheses -:comparison-of-constants (R0133): *Comparison between constants: '%s %s %s' has a constant value* +:comparison-of-constants (R0133): *Comparison between constants: "%s %s %s" has a constant value* When two literals are compared with each other the result is a constant. Using the constant directly is both easier to read and more performant. Initializing 'True' and 'False' this way is not required since Python 2.3. diff --git a/doc/user_guide/configuration/all-options.rst b/doc/user_guide/configuration/all-options.rst index 4df2575985..309714a0de 100644 --- a/doc/user_guide/configuration/all-options.rst +++ b/doc/user_guide/configuration/all-options.rst @@ -492,6 +492,13 @@ Standard Checkers **Default:** ``re.compile('^_')`` +--paramspec-rgx +""""""""""""""" +*Regular expression matching correct parameter specification variable names. If left empty, parameter specification variable names will be checked with the set naming style.* + +**Default:** ``None`` + + --property-classes """""""""""""""""" *List of decorators that produce properties, such as abc.abstractproperty. Add to this list to register other decorators that produce valid properties. These decorators are taken in consideration only for invalid-name.* @@ -513,6 +520,13 @@ Standard Checkers **Default:** ``None`` +--typevartuple-rgx +"""""""""""""""""" +*Regular expression matching correct type variable tuple names. If left empty, type variable tuple names will be checked with the set naming style.* + +**Default:** ``None`` + + --variable-naming-style """"""""""""""""""""""" *Naming style matching correct variable names.* @@ -604,12 +618,16 @@ Standard Checkers no-docstring-rgx = "^_" + # paramspec-rgx = + property-classes = ["abc.abstractproperty"] # typealias-rgx = # typevar-rgx = + # typevartuple-rgx = + # Possible choices: ['snake_case', 'camelCase', 'PascalCase', 'UPPER_CASE', 'any'] variable-naming-style = "snake_case"