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
1""" 2Python CLI-tool (without need for a GUI) to measure Internet speed with fast.com
3"""
4
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