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
|
tools/test/docstring_linter_testdata/more_python_code.py.txt:1: No docstring found for function 'a_very_very_long' (8 lines)
1 | def a_very_very_long():
^
2 | # Lots of lines!
3 | # Lots of lines!
4 | # Lots of lines!
5 | # Lots of lines!
tools/test/docstring_linter_testdata/more_python_code.py.txt:10: No docstring found for class 'LintInit' (6 lines)
8 |
9 |
10 | class LintInit:
^
11 | def __init__(self) -> None:
12 | # Lots of lines!
tools/test/docstring_linter_testdata/python_code.py.txt:17: No docstring found for class 'LongWithoutDocstring' (6 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, needed 16)
22 |
23 |
24 | class LongWithShortDocstring:
^
25 | """TODO"""
26 |
tools/test/docstring_linter_testdata/python_code.py.txt:54: No docstring found for function 'long_without_docstring' (7 lines)
52 |
53 |
54 | def long_without_docstring():
^
55 | #
56 | #
tools/test/docstring_linter_testdata/python_code.py.txt:71: No docstring found for function 'needs_docs' (12 lines). If the method overrides a method on a parent class, adding the `@typing_extensions.override` decorator will make this error go away.
69 | """This docstring, while short, is enough"""
70 |
71 | def needs_docs(self):
^
72 | def not_short():
73 | class Long:
|
