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
42
43
44
45
46
47
48
49
50
51
|
"""Tests for missing-param-doc and missing-type-doc for non-specified style docstrings
with accept-no-param-doc = no
"""
# pylint: disable=invalid-name, unused-argument, too-few-public-methods
def test_don_t_tolerate_no_param_documentation_at_all(x, y): # [missing-any-param-doc]
"""Example of a function with no parameter documentation at all
Missing documentation error message is emitted.
missing parameter documentation"""
def test_see_tolerate_no_param_documentation_at_all(x, y):
"""Example for the usage of "For the parameters, see"
to suppress missing-param warnings.
For the parameters, see :func:`blah`
"""
class ClassFoo:
"""Example usage of "For the parameters, see" in init docstring"""
def __init__(self, x, y):
"""docstring foo constructor
For the parameters, see :func:`bla`
"""
class ClassFooTwo:
"""test_see_sentence_for_constr_params_in_class
Example usage of "For the parameters, see" in class docstring
For the parameters, see :func:`bla`
"""
def __init__(self, x, y):
"""init"""
def test_kwonlyargs_are_taken_in_account( # [missing-param-doc, missing-type-doc]
arg, *, kwonly, missing_kwonly
):
"""The docstring
:param int arg: The argument.
:param bool kwonly: A keyword-arg.
"""
|
