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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
class ShortWithDocstring:
"""This docstring, while short, is enough"""
pass
class Short:
pass
class LongWithDocstring:
"""This docstring, while short, is enough"""
def short1(self):
pass
class LongWithoutDocstring:
# A comment isn't a docstring
def short1(self):
pass
class LongWithShortDocstring:
"""TODO"""
def short1(self):
pass
class _Protected:
"""TODO"""
def short1(self):
pass
def short():
#
#
#
pass
def long():
"""This docstring, while short, is enough"""
#
#
#
#
pass
def long_without_docstring():
#
#
#
#
pass
class ImpossibleCombo(
set,
tuple,
int,
):
# We could have comments
# before the doc comment
"""This docstring, while short, is enough"""
def needs_docs(self):
def not_short():
class Long:
a = 1
b = 1
c = 1
d = 1
e = 1
class Short:
pass
@override # Won't work!
class NotDocstring:
def short1(self):
pass
"""This is not a docstring"""
@override
def long_with_override(self):
#
#
#
#
pass
def short2(self):
pass
def short3(self):
pass
def long_with_omit(): # noqa: docstring_linter
#
#
#
#
pass
|
