One-line docstring should fit on one line with quotes FLK-D200
Documentation
Minor
4 months ago
—
a year old
One-line docstring should fit on one line with quotes
283 # Debug
284 verbose: bool = False,
285):
286 """287 Function that filters a `dict` by type of interface
288 """
289One-line docstring should fit on one line with quotes
74 # Debug
75 verbose: bool = False,
76):
77 """ 78 Generate an array based on dictionary with keys and values
79 """
80 array_command = []One-line docstring should fit on one line with quotes
63
64
65def _drop_keys_with_none_values(main_dict: dict):
66 """ 67 Drop keys with None values to parse safe dictionary config
68 """
69 return {k: v for k, v in main_dict.items() if v is not None}One-line docstring should fit on one line with quotes
17 # Debug
18 verbose: bool = False,
19):
20 """ 21 Print terminal output if are different to None and verbose activated
22 """
23
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