summaryrefslogtreecommitdiff
path: root/tests/functional/m/missing/missing_docstring.py
blob: 3b7a679df935b8bf8b2a769fb0eeffbd9c0b392b (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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
# [missing-module-docstring]
# pylint: disable=too-few-public-methods

def public_documented():
    """It has a docstring."""


def _private_undocumented():
    # Doesn't need a docstring
    pass


def _private_documented():
    """It has a docstring."""


class ClassDocumented:
    """It has a docstring."""


class ClassUndocumented: # [missing-class-docstring]
    pass


def public_undocumented(): # [missing-function-docstring]
    pass


def __sizeof__():
    # Special
    pass


def __mangled():
    pass


class Property:
    """Don't warn about setters and deleters."""

    def __init__(self):
        self._value = None

    @property
    def test(self):
        """Default docstring for setters and deleters."""

    @test.setter
    def test(self, value):
        self._value = value

    @test.deleter
    def test(self):
        pass


class DocumentedViaDunderDoc:
    __doc__ = "This one"