One-line docstring should fit on one line with quotes FLK-D200
Documentation
Minor
2 years ago
—
2 years old
One-line docstring should fit on one line with quotes
5
6
7class AngleDetection:
8 """ 9 This class helps you to find angles in an image.
10 """
11
Description
If a docstring fits in a single line (72 characters according to PEP8), it is recommended to have the quotes on the same line.
Bad practice
def foo():
"""
Runs bar and returns baz.
"""
baz = bar()
return baz
Recommended
def foo():
"""Runs bar and returns baz."""
baz = bar()
return baz