One-line docstring should fit on one line with quotes FLK-D200
Documentation
Minor
4 months ago
—
4 months old
One-line docstring should fit on one line with quotes
7 self.data_manager = data_manager
8
9 def uncertainty_sampling(self, num_samples):
10 """11 Selects the top `num_samples` data points with the highest uncertainty.
12 """
13 uncertainty_values = []
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