diff options
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 45 |
1 files changed, 23 insertions, 22 deletions
diff --git a/README.rst b/README.rst index a29f3ece8..740f7f308 100644 --- a/README.rst +++ b/README.rst @@ -5,11 +5,11 @@ .. This is used inside the doc to recover the start of the introduction -.. image:: https://github.com/PyCQA/pylint/actions/workflows/tests.yaml/badge.svg?branch=main - :target: https://github.com/PyCQA/pylint/actions +.. image:: https://github.com/pylint-dev/pylint/actions/workflows/tests.yaml/badge.svg?branch=main + :target: https://github.com/pylint-dev/pylint/actions -.. image:: https://codecov.io/gh/PyCQA/pylint/branch/main/graph/badge.svg?token=ZETEzayrfk - :target: https://codecov.io/gh/PyCQA/pylint +.. image:: https://codecov.io/gh/pylint-dev/pylint/branch/main/graph/badge.svg?token=ZETEzayrfk + :target: https://codecov.io/gh/pylint-dev/pylint .. image:: https://img.shields.io/pypi/v/pylint.svg :alt: Pypi Package version @@ -23,17 +23,17 @@ :target: https://github.com/ambv/black .. image:: https://img.shields.io/badge/linting-pylint-yellowgreen - :target: https://github.com/PyCQA/pylint + :target: https://github.com/pylint-dev/pylint -.. image:: https://results.pre-commit.ci/badge/github/PyCQA/pylint/main.svg - :target: https://results.pre-commit.ci/latest/github/PyCQA/pylint/main +.. image:: https://results.pre-commit.ci/badge/github/pylint-dev/pylint/main.svg + :target: https://results.pre-commit.ci/latest/github/pylint-dev/pylint/main :alt: pre-commit.ci status .. image:: https://bestpractices.coreinfrastructure.org/projects/6328/badge :target: https://bestpractices.coreinfrastructure.org/projects/6328 :alt: CII Best Practices -.. image:: https://api.securityscorecards.dev/projects/github.com/PyCQA/pylint/badge +.. image:: https://img.shields.io/ossf-scorecard/github.com/PyCQA/pylint?label=openssf%20scorecard&style=flat :target: https://api.securityscorecards.dev/projects/github.com/PyCQA/pylint :alt: OpenSSF Scorecard @@ -45,7 +45,7 @@ What is Pylint? --------------- Pylint is a `static code analyser`_ for Python 2 or 3. The latest version supports Python -3.7.2 and above. +3.8.0 and above. .. _`static code analyser`: https://en.wikipedia.org/wiki/Static_code_analysis @@ -78,14 +78,14 @@ It can also be integrated in most editors or IDEs. More information can be found .. This is used inside the doc to recover the end of the short text for installation -What differentiate Pylint? --------------------------- +What differentiates Pylint? +--------------------------- Pylint is not trusting your typing and is inferring the actual value of nodes (for a start because there was no typing when pylint started off) using its internal code representation (astroid). If your code is ``import logging as argparse``, Pylint can check and know that ``argparse.error(...)`` is in fact a logging call and not an -argparse call. This makes pylint slower, but it also let pylint find more issues if +argparse call. This makes pylint slower, but it also lets pylint find more issues if your code is not fully typed. [inference] is the killer feature that keeps us using [pylint] in our project despite how painfully slow it is. @@ -94,7 +94,8 @@ your code is not fully typed. .. _`Realist pylint user`: https://github.com/charliermarsh/ruff/issues/970#issuecomment-1381067064 pylint, not afraid of being a little slower than it already is, is also a lot more thorough than other linters. -There is more checks, some opinionated one that are deactivated by default, but can be enabled using configuration. +There are more checks, including some opinionated ones that are deactivated by default +but can be enabled using configuration. How to use pylint ----------------- @@ -103,12 +104,12 @@ Pylint isn't smarter than you: it may warn you about things that you have conscientiously done or check for some things that you don't care about. During adoption, especially in a legacy project where pylint was never enforced, it's best to start with the ``--errors-only`` flag, then disable -convention and refactor message with ``--disable=C,R`` and progressively +convention and refactor messages with ``--disable=C,R`` and progressively re-evaluate and re-enable messages as your priorities evolve. Pylint is highly configurable and permits to write plugins in order to add your own checks (for example, for internal libraries or an internal rule). Pylint also has an -ecosystem of existing plugins for popular frameworks and third party libraries. +ecosystem of existing plugins for popular frameworks and third-party libraries. .. note:: @@ -128,7 +129,7 @@ Advised linters alongside pylint -------------------------------- Projects that you might want to use alongside pylint include ruff_ (**really** fast, -with builtin auto-fix, and a growing number of checks taken from popular +with builtin auto-fix and a growing number of checks taken from popular linters but implemented in ``rust``) or flake8_ (faster and simpler checks with very few false positives), mypy_, pyright_ or pyre_ (typing checks), bandit_ (security oriented checks), black_ and isort_ (auto-formatting), autoflake_ (automated removal of unused imports or variables), @@ -173,7 +174,7 @@ Please follow the `code of conduct`_ and check `the Contributor Guides`_ if you make a code contribution. .. _creating issues because you found a bug or want a feature: https://pylint.readthedocs.io/en/latest/contact.html#bug-reports-feedback -.. _code of conduct: https://github.com/PyCQA/pylint/blob/main/CODE_OF_CONDUCT.md +.. _code of conduct: https://github.com/pylint-dev/pylint/blob/main/CODE_OF_CONDUCT.md .. _the Contributor Guides: https://pylint.readthedocs.io/en/latest/development_guide/contribute.html .. This is used inside the doc to recover the end of the short text for contribution @@ -184,7 +185,7 @@ Show your usage You can place this badge in your README to let others know your project uses pylint. .. image:: https://img.shields.io/badge/linting-pylint-yellowgreen - :target: https://github.com/PyCQA/pylint + :target: https://github.com/pylint-dev/pylint Learn how to add a badge to your documentation in the `the badge documentation`_. @@ -193,12 +194,12 @@ Learn how to add a badge to your documentation in the `the badge documentation`_ License ------- -pylint is, with a few exceptions listed below, `GPLv2 <https://github.com/PyCQA/pylint/blob/main/LICENSE>`_. +pylint is, with a few exceptions listed below, `GPLv2 <https://github.com/pylint-dev/pylint/blob/main/LICENSE>`_. The icon files are licensed under the `CC BY-SA 4.0 <https://creativecommons.org/licenses/by-sa/4.0/>`_ license: -- `doc/logo.png <https://raw.githubusercontent.com/PyCQA/pylint/main/doc/logo.png>`_ -- `doc/logo.svg <https://raw.githubusercontent.com/PyCQA/pylint/main/doc/logo.svg>`_ +- `doc/logo.png <https://raw.githubusercontent.com/pylint-dev/pylint/main/doc/logo.png>`_ +- `doc/logo.svg <https://raw.githubusercontent.com/pylint-dev/pylint/main/doc/logo.svg>`_ Support ------- @@ -207,7 +208,7 @@ Please check `the contact information`_. .. _`the contact information`: https://pylint.readthedocs.io/en/latest/contact.html -.. |tideliftlogo| image:: https://raw.githubusercontent.com/PyCQA/pylint/main/doc/media/Tidelift_Logos_RGB_Tidelift_Shorthand_On-White.png +.. |tideliftlogo| image:: https://raw.githubusercontent.com/pylint-dev/pylint/main/doc/media/Tidelift_Logos_RGB_Tidelift_Shorthand_On-White.png :width: 200 :alt: Tidelift |