summaryrefslogtreecommitdiff
path: root/tests/functional/ext/docparams.py
blob: 8dbb0295afaa9980bfad3e97ba4886de6df9fdb9 (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
31
32
33
34
35
36
37
38
39
40
41
"""Fixture for testing missing documentation in docparams."""


def _private_func1(param1):  # [missing-return-doc, missing-return-type-doc]
    """This is a test docstring without returns"""
    return param1


def _private_func2(param1):  # [missing-yield-doc, missing-yield-type-doc]
    """This is a test docstring without yields"""
    yield param1


def _private_func3(param1):  # [missing-raises-doc]
    """This is a test docstring without raises"""
    raise Exception('Example')


def public_func1(param1):  # [missing-any-param-doc]
    """This is a test docstring without params"""
    print(param1)


async def _async_private_func1(param1):  # [missing-return-doc, missing-return-type-doc]
    """This is a test docstring without returns"""
    return param1


async def _async_private_func2(param1):  # [missing-yield-doc, missing-yield-type-doc]
    """This is a test docstring without yields"""
    yield param1


async def _async_private_func3(param1):  # [missing-raises-doc]
    """This is a test docstring without raises"""
    raise Exception('Example')


async def async_public_func1(param1):  # [missing-any-param-doc]
    """This is a test docstring without params"""
    print(param1)