Skip to content

Commit b847daf

Browse files
committed
update a few docstrings
1 parent 2f6bd0c commit b847daf

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

just_playback/playback.py

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,6 @@ def load_file(self, path_to_file: str) -> None:
5555
self.__bind(lib.set_device_volume(self.__ma_attrs))
5656

5757
self.__file_duration = TinyTag.get(path_to_file).duration
58-
59-
return True
6058

6159
def play(self) -> None:
6260
"""
@@ -161,7 +159,7 @@ def loop_at_end(self, loops_at_end: bool) -> None:
161159
@property
162160
def active(self) -> bool:
163161
"""
164-
Returns True if playback is playing or is paused and False otherwise
162+
True if playback is playing or is paused and False otherwise
165163
"""
166164

167165
if not self.__ma_attrs.audio_stream_ready:
@@ -173,7 +171,7 @@ def active(self) -> bool:
173171
@property
174172
def curr_pos(self) -> float:
175173
"""
176-
Returns playback's current position/offset in seconds from the
174+
The playback's current position/offset in seconds from the
177175
beginning of audio file if playback is active or the file has
178176
been loaded and -1 otherwise
179177
"""
@@ -194,7 +192,7 @@ def paused(self) -> bool:
194192
@property
195193
def duration(self) -> float:
196194
"""
197-
Returns the length in seconds of the audio file, which is 0 if no file has
195+
The length in seconds of the audio file, which is 0 if no file has
198196
been loaded
199197
"""
200198

@@ -203,7 +201,7 @@ def duration(self) -> float:
203201
@property
204202
def volume(self) -> float:
205203
"""
206-
Returns playback's current volume, a value in the interval [0, 1]
204+
The playback's current volume, a value in the interval [0, 1]
207205
"""
208206

209207
if self.active:

0 commit comments

Comments
 (0)