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
30 NoneType = "none"
31
32 class GenerationResult:
33 """ 34 A class that represents the result of the art generation.
35 """
36 def __init__(self, images: List[str], next_prompt: str, duration: float):One-line docstring should fit on one line with quotes
21 """
22
23 class Model:
24 """ 25 A class that contains constants for the available models.
26 """
27 Art = "art"
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