summaryrefslogtreecommitdiff
path: root/tests/functional/ext/docparams/parameter/missing_param_doc_required_no_doc_rgx_test_all.py
blob: 829119a09a84bc4a917b89c3d8e4b6dea2f0ee18 (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
"""Tests for missing-param-doc and missing-type-doc for non-specified style docstrings
with accept-no-param-doc = no and no-docstring-rgx = ^$
"""
# pylint: disable=invalid-name, unused-argument, too-few-public-methods, function-redefined
# pylint: disable=missing-class-docstring


class MyClass:
    """test_all_docstring_rgx
    Function that matches "check all functions" 'no-docstring-rgx' config option
    No error message is emitted.
    """

    def __init__(self, my_param: int) -> None:
        """
        My init docstring
        :param my_param: My first param
        """


# test_fail_empty_docstring_rgx
# Function that matches "check all functions" 'no-docstring-rgx' config option
# An error message is emitted.
class MyClass:
    def __init__(self, my_param: int) -> None:  # [missing-param-doc]
        """
        My init docstring
        """