.. _useless-param-doc:

useless-param-doc / W9019
=========================

**Message emitted:**

``"%s" useless ignored parameter documentation``

**Description:**

*Please remove the ignored parameter documentation.*

**Problematic code:**

.. literalinclude:: /data/messages/u/useless-param-doc/bad.py
   :language: python

**Correct code:**

.. literalinclude:: /data/messages/u/useless-param-doc/good.py
   :language: python

**Configuration file:**

.. literalinclude:: /data/messages/u/useless-param-doc/pylintrc
    :language: ini





.. note::
  This message is emitted by the optional :ref:`'parameter_documentation'<pylint.extensions.docparams>`
  checker, which requires the ``pylint.extensions.docparams`` plugin to be loaded.

Created by the `parameter_documentation <https://github.com/pylint-dev/pylint/blob/main/pylint/extensions/docparams.py>`__ checker.