.. _missing-yield-doc:

missing-yield-doc / W9013
=========================

**Message emitted:**

``Missing yield documentation``

**Description:**

*Please add documentation about what this generator yields.*

**Problematic code:**

.. literalinclude:: /data/messages/m/missing-yield-doc/bad.py
   :language: python

**Correct code:**

.. literalinclude:: /data/messages/m/missing-yield-doc/good.py
   :language: python

**Configuration file:**

.. literalinclude:: /data/messages/m/missing-yield-doc/pylintrc
    :language: ini

**Additional details:**

This message is raised only when parameter ``accept-no-yields-doc`` is set to ``no``.




.. 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.