summaryrefslogtreecommitdiff
path: root/tests/functional/ext/docparams/parameter/missing_param_doc_required_no_doc_rgx_check_init.py
blob: 1d6d2c70bcfaed9350c8864f73dd1a2ebf4bc23a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
"""Tests for missing-param-doc and missing-type-doc for non-specified style docstrings
with accept-no-param-doc = no and no-docstring-rgx = ^(?!__init__$)_
"""
# pylint: disable=invalid-name, unused-argument, too-few-public-methods, missing-class-docstring


# test_fail_docparams_check_init
# Check that __init__ is checked correctly, but other private methods aren't
class MyClass:
    def __init__(self, my_param: int) -> None:  # [missing-param-doc]
        """
        My init docstring
        """

    def _private_method(self, my_param: int) -> None:
        """
        My private method
        """