Skip to content

Commit 5ca7139

Browse files
committed
minor docs edit
1 parent c2b8359 commit 5ca7139

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

adafruit_midi_parser.py

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ def num_tracks(self) -> int:
101101
return self._num_tracks
102102

103103
@property
104-
def is_parsed(self) -> bool:
104+
def parsed(self) -> bool:
105105
"""Whether the MIDI file has been successfully parsed."""
106106
return self._parsed
107107

@@ -138,7 +138,7 @@ def next_event(self) -> Optional[Dict[str, Any]]:
138138
return event
139139

140140
@property
141-
def has_more_events(self) -> bool:
141+
def more_events(self) -> bool:
142142
"""Whether there are more events to be played."""
143143
return self._current_event_index < len(self._events)
144144

@@ -477,7 +477,7 @@ def __init__(self, midi_parser: MIDIParser) -> None:
477477
:param MIDIParser midi_parser: A MIDIParser instance
478478
:raises MIDIParseError: If the provided parser hasn't parsed a file yet
479479
"""
480-
if not midi_parser.is_parsed:
480+
if not midi_parser.parsed:
481481
raise MIDIParseError("MIDI parser must parse a file before creating a player")
482482

483483
self._parser: MIDIParser = midi_parser
@@ -499,14 +499,14 @@ def restart_delay(self) -> float:
499499
@restart_delay.setter
500500
def restart_delay(self, delay: float) -> None:
501501
"""
502-
Set the delay in seconds before restarting playback when looping.
502+
The delay in seconds before restarting playback when looping.
503503
504504
:param float delay: Delay in seconds (minimum 0.1s)
505505
"""
506506
self._restart_delay = max(0.1, float(delay)) # Minimum 0.1 second
507507

508508
@property
509-
def is_playing(self) -> bool:
509+
def playing(self) -> bool:
510510
"""Whether the player is currently playing."""
511511
return self._playing
512512

@@ -523,14 +523,13 @@ def loop_playback(self) -> bool:
523523
@loop_playback.setter
524524
def loop_playback(self, value: bool) -> None:
525525
"""
526-
Set whether playback should automatically loop when finished.
527526
528527
:param bool value: True to enable looping, False to disable
529528
"""
530529
self._loop_playback = bool(value)
531530

532531
@property
533-
def is_finished(self) -> bool:
532+
def finished(self) -> bool:
534533
"""Whether playback has completed (and not set to loop)."""
535534
return self._finished
536535

0 commit comments

Comments
 (0)