One-line docstring should fit on one line with quotes FLK-D200
Documentation
Minor
3 years ago
—
3 years old
One-line docstring should fit on one line with quotes
140 return self.current_state
141
142 def LoadStateMachine(self):
143 """144 This Function load state machine configuration
145 """
146 if self.states is not None: One-line docstring should fit on one line with quotes
110 self.saved_state = [self.current_state, self.context]
111
112 def __RestoreState(self):
113 """114 This Function restores the saved state
115 """
116 self.current_state = self.saved_state[0] One-line docstring should fit on one line with quotes
104 return all_action_executed
105
106 def __SaveState(self):
107 """108 This Function saves internal state
109 """
110 self.saved_state = [self.current_state, self.context]
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