One-line docstring should fit on one line with quotes FLK-D200
Documentation
Minor
3 months ago
—
3 months old
One-line docstring should fit on one line with quotes
9 return data
10
11def visualize_results(data):
12 """13 Visualize the analysis results
14 """
15 plt.scatter(data[:, 0], data[:, 1], c=data[:, 2])One-line docstring should fit on one line with quotes
2import pandas as pd
3
4def load_data(file_path):
5 """ 6 Load data from a CSV file
7 """
8 data = pd.read_csv(file_path)One-line docstring should fit on one line with quotes
21 return model
22
23def save_model(model, file_path):
24 """25 Save the trained model to a file
26 """
27 import joblibOne-line docstring should fit on one line with quotes
10 return data
11
12def train_model(data):
13 """14 Train a random forest model
15 """
16 X = data.drop('target', axis=1)One-line docstring should fit on one line with quotes
3from sklearn.model_selection import train_test_split
4
5def load_data(file_path):
6 """ 7 Load data from a CSV file
8 """
9 data = pd.read_csv(file_path)
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