summaryrefslogtreecommitdiff
path: root/doc/user_guide
diff options
context:
space:
mode:
authorPierre Sassoulas <pierre.sassoulas@gmail.com>2023-03-07 22:57:04 +0100
committerGitHub <noreply@github.com>2023-03-07 22:57:04 +0100
commitee2e63519b15683d8c93626695c97936eb956ebf (patch)
treef390f30ae273f8dd4c1829e32e079a18ab71ceba /doc/user_guide
parentca2549708acd3ede6621c56477b1c0333eb62254 (diff)
downloadpylint-git-ee2e63519b15683d8c93626695c97936eb956ebf.tar.gz
Bump pylint to 2.17.0, update changelog (#8395)
Diffstat (limited to 'doc/user_guide')
-rw-r--r--doc/user_guide/checkers/features.rst14
-rw-r--r--doc/user_guide/configuration/all-options.rst13
-rw-r--r--doc/user_guide/messages/messages_overview.rst1
3 files changed, 20 insertions, 8 deletions
diff --git a/doc/user_guide/checkers/features.rst b/doc/user_guide/checkers/features.rst
index ee6d0e22e..9a7c8a4ff 100644
--- a/doc/user_guide/checkers/features.rst
+++ b/doc/user_guide/checkers/features.rst
@@ -324,6 +324,9 @@ Classes checker Messages
Used when an instance attribute is defined outside the __init__ method.
:subclassed-final-class (W0240): *Class %r is a subclass of a class decorated with typing.final: %r*
Used when a class decorated with typing.final has been subclassed.
+:implicit-flag-alias (W0213): *Flag member %(overlap)s shares bit positions with %(sources)s*
+ Used when multiple integer values declared within an enum.IntFlag class share
+ a common bit position.
:abstract-method (W0223): *Method %r is abstract in class %r but is not overridden in child class %r*
Used when an abstract method (i.e. raise NotImplementedError) is not
overridden in concrete class.
@@ -742,9 +745,9 @@ Verbatim name of the checker is ``nonascii-checker``.
Nonascii-Checker checker Messages
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
:non-ascii-file-name (W2402): *%s name "%s" contains a non-ASCII character.*
- Under python 3.5, PEP 3131 only allows non-ascii identifiers, not file
- names.Since Python 3.5, even though Python supports UTF-8 files, some editors
- or tools don't.
+ Under python 3.5, PEP 3131 allows non-ascii identifiers, but not non-ascii
+ file names.Since Python 3.5, even though Python supports UTF-8 files, some
+ editors or tools don't.
:non-ascii-name (C2401): *%s name "%s" contains a non-ASCII character, consider renaming it.*
Used when the name contains at least one non-ASCII unicode character. See
https://peps.python.org/pep-0672/#confusing-features for a background why
@@ -1264,9 +1267,8 @@ Unicode Checker checker Messages
:invalid-unicode-codec (E2501): *UTF-16 and UTF-32 aren't backward compatible. Use UTF-8 instead*
For compatibility use UTF-8 instead of UTF-16/UTF-32. See also
https://bugs.python.org/issue1503789 for a history of this issue. And
- https://softwareengineering.stackexchange.com/questions/102205/should-
- utf-16-be-considered-harmful for some possible problems when using UTF-16 for
- instance.
+ https://softwareengineering.stackexchange.com/questions/102205/ for some
+ possible problems when using UTF-16 for instance.
:bad-file-encoding (C2503): *PEP8 recommends UTF-8 as encoding for Python files*
PEP8 recommends UTF-8 default encoding for Python files. See
https://peps.python.org/pep-0008/#source-file-encoding
diff --git a/doc/user_guide/configuration/all-options.rst b/doc/user_guide/configuration/all-options.rst
index 21c58a057..13d67c280 100644
--- a/doc/user_guide/configuration/all-options.rst
+++ b/doc/user_guide/configuration/all-options.rst
@@ -499,6 +499,13 @@ Standard Checkers
**Default:** ``('abc.abstractproperty',)``
+--typealias-rgx
+"""""""""""""""
+*Regular expression matching correct type alias names. If left empty, type alias names will be checked with the set naming style.*
+
+**Default:** ``None``
+
+
--typevar-rgx
"""""""""""""
*Regular expression matching correct type variable names. If left empty, type variable names will be checked with the set naming style.*
@@ -589,6 +596,8 @@ Standard Checkers
property-classes = ["abc.abstractproperty"]
+ # typealias-rgx =
+
# typevar-rgx =
variable-naming-style = "snake_case"
@@ -624,7 +633,7 @@ Standard Checkers
"""""""""""""""""""
*List of member names, which should be excluded from the protected access warning.*
-**Default:** ``('_asdict', '_fields', '_replace', '_source', '_make')``
+**Default:** ``('_asdict', '_fields', '_replace', '_source', '_make', 'os._exit')``
--valid-classmethod-first-arg
@@ -656,7 +665,7 @@ Standard Checkers
defining-attr-methods = ["__init__", "__new__", "setUp", "__post_init__"]
- exclude-protected = ["_asdict", "_fields", "_replace", "_source", "_make"]
+ exclude-protected = ["_asdict", "_fields", "_replace", "_source", "_make", "os._exit"]
valid-classmethod-first-arg = ["cls"]
diff --git a/doc/user_guide/messages/messages_overview.rst b/doc/user_guide/messages/messages_overview.rst
index a1962f8e0..167802ae2 100644
--- a/doc/user_guide/messages/messages_overview.rst
+++ b/doc/user_guide/messages/messages_overview.rst
@@ -252,6 +252,7 @@ All messages in the warning category:
warning/global-statement
warning/global-variable-not-assigned
warning/global-variable-undefined
+ warning/implicit-flag-alias
warning/implicit-str-concat
warning/import-self
warning/inconsistent-quotes