missing-yield-type-doc / W9014

Message emitted:

Missing yield type documentation

Description:

Please document the type yielded by this method.

Problematic code:

def even_number_under(n: int):  # [missing-yield-type-doc]
    """Prints even numbers smaller than n.
    Args:
        n: Upper limit of even numbers.

    Yields:
        even numbers
    """
    for i in range(n):
        if i % 2 == 1:
            continue
        yield i

Correct code:

from typing import Iterator


def even_number_under(n: int) -> Iterator[int]:
    """Prints even numbers smaller than n.
    Args:
        n: Upper limit of even numbers.

    Yields:
        even numbers
    """
    for i in range(n):
        if i % 2 == 1:
            continue
        yield i

Configuration file:

[main]
load-plugins=pylint.extensions.docparams

[Parameter_documentation]
accept-no-yields-doc=no

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 'parameter_documentation' checker, which requires the pylint.extensions.docparams plugin to be loaded.

Created by the parameter_documentation checker.