Skip to content

Commit badf459

Browse files
[doc] Upgrade the generated documentation with tox -e docs
1 parent d201750 commit badf459

File tree

4 files changed

+12
-3
lines changed

4 files changed

+12
-3
lines changed

doc/user_guide/checkers/extensions.rst

+4
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,10 @@ Code Style checker Messages
7777
:consider-using-namedtuple-or-dataclass (R6101): *Consider using namedtuple or dataclass for dictionary values*
7878
Emitted when dictionary values can be replaced by namedtuples or dataclass
7979
instances.
80+
:prefer-typing-namedtuple (R6105): *Prefer 'typing.NamedTuple' over 'collections.namedtuple'*
81+
'typing.NamedTuple' uses the well-known 'class' keyword with type-hints for
82+
readability (it's also faster as it avoids an internal exec call). Disabled
83+
by default!
8084
:consider-using-assignment-expr (R6103): *Use '%s' instead*
8185
Emitted when an if assignment is directly followed by an if statement and
8286
both can be combined by using an assignment expression ``:=``. Requires

doc/user_guide/checkers/features.rst

+5-2
Original file line numberDiff line numberDiff line change
@@ -398,8 +398,7 @@ Dataclass checker Messages
398398
^^^^^^^^^^^^^^^^^^^^^^^^^^
399399
:invalid-field-call (E3701): *Invalid usage of field(), %s*
400400
The dataclasses.field() specifier should only be used as the value of an
401-
assignment within a dataclass, or within the make_dataclass() function. This
402-
message can't be emitted when using Python < 3.7.
401+
assignment within a dataclass, or within the make_dataclass() function.
403402

404403

405404
Design checker
@@ -1238,6 +1237,10 @@ Typecheck checker Messages
12381237
:unsubscriptable-object (E1136): *Value '%s' is unsubscriptable*
12391238
Emitted when a subscripted value doesn't support subscription (i.e. doesn't
12401239
define __getitem__ method or __class_getitem__ for a class).
1240+
:kwarg-superseded-by-positional-arg (W1117): *%r will be included in %r since a positional-only parameter with this name already exists*
1241+
Emitted when a function is called with a keyword argument that has the same
1242+
name as a positional-only parameter and the function contains a keyword
1243+
variadic parameter dict.
12411244
:keyword-arg-before-vararg (W1113): *Keyword argument before variable positional arguments list in the definition of %s function*
12421245
When defining a keyword argument before variable positional arguments, one
12431246
can end up in having multiple values passed for the aforementioned parameter

doc/user_guide/configuration/all-options.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ Standard Checkers
233233
234234
confidence = ["HIGH", "CONTROL_FLOW", "INFERENCE", "INFERENCE_FAILURE", "UNDEFINED"]
235235
236-
disable = ["raw-checker-failed", "bad-inline-option", "locally-disabled", "file-ignored", "suppressed-message", "useless-suppression", "deprecated-pragma", "use-implicit-booleaness-not-comparison-to-string", "use-implicit-booleaness-not-comparison-to-zero", "use-symbolic-message-instead", "consider-using-augmented-assign"]
236+
disable = ["raw-checker-failed", "bad-inline-option", "locally-disabled", "file-ignored", "suppressed-message", "useless-suppression", "deprecated-pragma", "use-implicit-booleaness-not-comparison-to-string", "use-implicit-booleaness-not-comparison-to-zero", "use-symbolic-message-instead", "consider-using-augmented-assign", "prefer-typing-namedtuple"]
237237
238238
enable = []
239239

doc/user_guide/messages/messages_overview.rst

+2
Original file line numberDiff line numberDiff line change
@@ -262,6 +262,7 @@ All messages in the warning category:
262262
warning/invalid-overridden-method
263263
warning/isinstance-second-argument-not-valid-type
264264
warning/keyword-arg-before-vararg
265+
warning/kwarg-superseded-by-positional-arg
265266
warning/logging-format-interpolation
266267
warning/logging-fstring-interpolation
267268
warning/logging-not-lazy
@@ -508,6 +509,7 @@ All messages in the refactor category:
508509
refactor/no-else-return
509510
refactor/no-self-use
510511
refactor/no-staticmethod-decorator
512+
refactor/prefer-typing-namedtuple
511513
refactor/property-with-parameters
512514
refactor/redefined-argument-from-local
513515
refactor/redefined-variable-type

0 commit comments

Comments
 (0)