summaryrefslogtreecommitdiff
path: root/tests/functional/ext/docparams/yield/missing_yield_doc_required.py
blob: bfaae4f03cec0bbb14fccb78fc2ee6c7c6d41050 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
"""Tests for missing-yield-doc and missing-yield-type-doc with accept-no-yields-doc = no"""
# pylint: disable=missing-function-docstring, unused-argument, function-redefined

from typing import Iterator


# Test missing docstring
def my_func(self):  # [missing-yield-doc, missing-yield-type-doc]
    yield False


# This function doesn't require a docstring, because its name starts
# with an '_' (no-docstring-rgx):
def _function(some_arg: int) -> Iterator[int]:
    yield some_arg