One-line docstring should fit on one line with quotes FLK-D200
Documentation
Minor
5 months ago
—
5 months old
One-line docstring should fit on one line with quotes
111
112
113def run_holographic_education_platform(sketch):
114 """115 Run the holographic medical education platform.
116 """
117 # Start the sketchOne-line docstring should fit on one line with quotes
99
100
101def add_holographic_collaboration(sketch, collaboration_path):
102 """103 Add a holographic collaboration to the sketch.
104 """
105 # Load the collaborationOne-line docstring should fit on one line with quotes
87
88
89def add_holographic_simulation(sketch, simulation_path):
90 """ 91 Add a holographic simulation to the sketch.
92 """
93 # Load the simulationOne-line docstring should fit on one line with quotes
75
76
77def add_holographic_model(sketch, model_path):
78 """ 79 Add a holographic model to the sketch.
80 """
81 # Load the modelOne-line docstring should fit on one line with quotes
22
23
24def create_holographic_education_platform():
25 """ 26 Create a holographic medical education platform.
27 """
28 # Create a new sketch
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