From ea86fcf71af6f2e39ce1fdcab5f8bf05b4d32082 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dani=C3=ABl=20van=20Noord?= <13665637+DanielNoord@users.noreply.github.com> Date: Thu, 22 Sep 2022 13:54:57 +0200 Subject: A collection of documentation updates (#7512) * Update ``exec--used`` documentation Closes https://github.com/PyCQA/pylint/issues/7039 * Be more explicit about third party plugins Closes https://github.com/PyCQA/pylint/issues/6900 * Document behaviour of config file generators Refs. https://github.com/PyCQA/pylint/issues/7478 Co-authored-by: Mark Byrne <31762852+mbyrnepr2@users.noreply.github.com> Co-authored-by: Pierre Sassoulas --- README.rst | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) (limited to 'README.rst') diff --git a/README.rst b/README.rst index e6e20b43e..3d99a0965 100644 --- a/README.rst +++ b/README.rst @@ -59,10 +59,19 @@ will know that ``argparse.error(...)`` is in fact a logging call and not an argp .. _`code smells`: https://martinfowler.com/bliki/CodeSmell.html 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 has an -ecosystem of existing plugins for popular frameworks such as `pylint-django`_ or -`pylint-sonarjson`_. +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. +.. note:: + + Pylint supports the Python standard library out of the box. Third-party + libraries are not always supported, so a plugin might be needed. A good place + to start is ``PyPI`` which often returns a plugin by searching for + ``pylint ``. `pylint-pydantic`_, `pylint-django`_ and + `pylint-sonarjson`_ are examples of such plugins. More information about plugins + and how to load them can be found at :ref:`plugins `. + +.. _`pylint-pydantic`: https://pypi.org/project/pylint-pydantic .. _`pylint-django`: https://github.com/PyCQA/pylint-django .. _`pylint-sonarjson`: https://github.com/omegacen/pylint-sonarjson -- cgit v1.2.1