One-line docstring should fit on one line with quotes FLK-D200
Documentation
Minor
a year ago
—
a year old
One-line docstring should fit on one line with quotes
18
19@app.route("/", methods=["GET"])
20def index():
21 """22 Test endpoint.
23 """
24 return make_response("", 200)
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