One-line docstring should fit on one line with quotes FLK-D200
Documentation
Minor
2 months ago
—
2 years old
One-line docstring should fit on one line with quotes
109 self.is_adding_song = False
110
111 async def toggle_autoplay(self):
112 """113 Toggle autoplay for the player.
114 """
115 if not self.autoplay:One-line docstring should fit on one line with quotes
129 self._lyrics = None
130
131 async def toggle_lyrics(self):
132 """133 Toggle lyrics display for the player.
134 """
135 self.show_lyrics = not self.show_lyricsOne-line docstring should fit on one line with quotes
123 self.queue.remove(item)
124
125 def reset_lyrics(self):
126 """127 Reset the lyrics cache.
128 """
129 self._lyrics = NoneOne-line docstring should fit on one line with quotes
47 return self._guild
48
49 async def fetch_and_update_lyrics(self) -> Union[Lyrics[LyricLine], None]:
50 """ 51 Fetch and update the lyrics to the cache for the current playing track.
52 """
53 if self._lyrics == MISSING:
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