summaryrefslogtreecommitdiff
path: root/tests/functional/ext/docparams/yield/missing_yield_doc_Numpy.py
blob: ed827550b3fe7e4ee1af9d5098edffa679946c62 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
"""Tests for missing-yield-doc and missing-yield-type-doc for Numpy style docstrings"""
# pylint: disable=missing-function-docstring, unused-argument, function-redefined
# pylint: disable=invalid-name, undefined-variable


# Test redundant yields docstring variants
def my_func(self):
    """This is a docstring.

    Yields
    -------
        int
            One
        None
            Sometimes
    """
    if a_func():
        yield None
    yield 1


def my_func(self):  # [redundant-yields-doc]
    """This is a docstring.

    Yields
    -------
        int
            One
    """
    return 1