pytorch/tools/test/docstring_linter_testdata/python_code.py.txt.lintrunner

32 lines
1.1 KiB
Plaintext

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: