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
|
tools/test/docstring_linter_testdata/python_code.py.txt:17: No docstring found for class 'LongWithoutDocstring' (4 lines)
15 |
16 |
17 | class LongWithoutDocstring:
^
18 | # A comment isn't a docstring
19 |
tools/test/docstring_linter_testdata/python_code.py.txt:24: docstring found for class 'LongWithShortDocstring' (6 lines) was too short (10 characters)
22 |
23 |
24 | class LongWithShortDocstring:
^
25 | """TODO"""
26 |
tools/test/docstring_linter_testdata/python_code.py.txt:71: No docstring found for function 'needs_docs' (12 lines)
69 | """This docstring, while short, is enough"""
70 |
71 | def needs_docs(self):
^
72 | def not_short():
73 | class Long:
tools/test/docstring_linter_testdata/python_code.py.txt:72: No docstring found for function 'not_short' (11 lines)
70 |
71 | def needs_docs(self):
72 | def not_short():
^
73 | class Long:
74 | a = 1
tools/test/docstring_linter_testdata/python_code.py.txt:73: No docstring found for class 'Long' (6 lines)
71 | def needs_docs(self):
72 | def not_short():
73 | class Long:
^
74 | a = 1
75 | b = 1
tools/test/docstring_linter_testdata/python_code.py.txt:84: No docstring found for class 'NotDocstring' (12 lines)
82 |
83 |
84 | class NotDocstring:
^
85 | def short1(self):
86 | pass
Top 3 undocumented classs:
12 lines: tools/test/docstring_linter_testdata/python_code.py.txt:NotDocstring
6 lines: tools/test/docstring_linter_testdata/python_code.py.txt:LongWithShortDocstring
6 lines: tools/test/docstring_linter_testdata/python_code.py.txt:Long
Top 2 undocumented functions:
12 lines: tools/test/docstring_linter_testdata/python_code.py.txt:needs_docs
11 lines: tools/test/docstring_linter_testdata/python_code.py.txt:not_short
|
