diff options
| author | Ollie <46904826+ollie-iterators@users.noreply.github.com> | 2023-02-16 16:28:57 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-02-16 22:28:57 +0100 |
| commit | e0018ea04bce285f5fed31c00d6d16367a8800c1 (patch) | |
| tree | f6f424bcf6e79431146f9d9a44cf8c9af1867d0e | |
| parent | 884034d342eeb3fd753733176ff99774f822f336 (diff) | |
| download | pylint-git-e0018ea04bce285f5fed31c00d6d16367a8800c1.tar.gz | |
[doc] 'file-ignored' and 'import-private-name' (#8304)
Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
| -rw-r--r-- | doc/data/messages/f/file-ignored/bad.py | 2 | ||||
| -rw-r--r-- | doc/data/messages/f/file-ignored/details.rst | 2 | ||||
| -rw-r--r-- | doc/data/messages/f/file-ignored/good.py | 1 | ||||
| -rw-r--r-- | doc/data/messages/i/import-private-name/bad.py | 7 | ||||
| -rw-r--r-- | doc/data/messages/i/import-private-name/details.rst | 3 | ||||
| -rw-r--r-- | doc/data/messages/i/import-private-name/good.py | 9 | ||||
| -rw-r--r-- | doc/data/messages/i/import-private-name/pylintrc | 2 |
7 files changed, 22 insertions, 4 deletions
diff --git a/doc/data/messages/f/file-ignored/bad.py b/doc/data/messages/f/file-ignored/bad.py new file mode 100644 index 000000000..ce0456485 --- /dev/null +++ b/doc/data/messages/f/file-ignored/bad.py @@ -0,0 +1,2 @@ +# pylint: skip-file +# -1: [file-ignored] diff --git a/doc/data/messages/f/file-ignored/details.rst b/doc/data/messages/f/file-ignored/details.rst index ab8204529..c979ac716 100644 --- a/doc/data/messages/f/file-ignored/details.rst +++ b/doc/data/messages/f/file-ignored/details.rst @@ -1 +1 @@ -You can help us make the doc better `by contributing <https://github.com/PyCQA/pylint/issues/5953>`_ ! +There's no checks at all for a file if it starts by ``# pylint: skip-file``. diff --git a/doc/data/messages/f/file-ignored/good.py b/doc/data/messages/f/file-ignored/good.py index c40beb573..e69de29bb 100644 --- a/doc/data/messages/f/file-ignored/good.py +++ b/doc/data/messages/f/file-ignored/good.py @@ -1 +0,0 @@ -# This is a placeholder for correct code for this message. diff --git a/doc/data/messages/i/import-private-name/bad.py b/doc/data/messages/i/import-private-name/bad.py new file mode 100644 index 000000000..96a2a9fc9 --- /dev/null +++ b/doc/data/messages/i/import-private-name/bad.py @@ -0,0 +1,7 @@ +from argparse import _AttributeHolder, _SubParsersAction # [import-private-name] + +attr_holder = _AttributeHolder() + +def add_sub_parser(sub_parsers: _SubParsersAction): + sub_parsers.add_parser('my_subparser') + # ... diff --git a/doc/data/messages/i/import-private-name/details.rst b/doc/data/messages/i/import-private-name/details.rst index ab8204529..48c108984 100644 --- a/doc/data/messages/i/import-private-name/details.rst +++ b/doc/data/messages/i/import-private-name/details.rst @@ -1 +1,2 @@ -You can help us make the doc better `by contributing <https://github.com/PyCQA/pylint/issues/5953>`_ ! +Using private imports expose you to unexpected breaking changes for any version +bump of your dependencies, even in patch versions. diff --git a/doc/data/messages/i/import-private-name/good.py b/doc/data/messages/i/import-private-name/good.py index c40beb573..3a5599cfb 100644 --- a/doc/data/messages/i/import-private-name/good.py +++ b/doc/data/messages/i/import-private-name/good.py @@ -1 +1,8 @@ -# This is a placeholder for correct code for this message. +"""Private import can be used as type annotations.""" + +from argparse import _SubParsersAction + + +def add_sub_parser(sub_parsers: _SubParsersAction): + sub_parsers.add_parser('my_subparser') + # ... diff --git a/doc/data/messages/i/import-private-name/pylintrc b/doc/data/messages/i/import-private-name/pylintrc new file mode 100644 index 000000000..09cf103b6 --- /dev/null +++ b/doc/data/messages/i/import-private-name/pylintrc @@ -0,0 +1,2 @@ +[main] +load-plugins = pylint.extensions.private_import |