One-line docstring should fit on one line with quotes FLK-D200
Documentation
Minor
4 months ago
—
2 years old
One-line docstring should fit on one line with quotes
175 @property
176 def epoch(self):
177 # type: () -> int
178 """179 An integer giving the version epoch of this Version instance
180 """
181 _epoch = self._version.epoch # type: int
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