Skip to content

Commit 6a5f834

Browse files
authored
Merge pull request #41 from EMATech/mtc
Update documentation
2 parents 0f56516 + 68d59e5 commit 6a5f834

File tree

4 files changed

+21
-10
lines changed

4 files changed

+21
-10
lines changed

adafruit_midi/midi_continue.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# SPDX-License-Identifier: MIT
44

55
"""
6-
`adafruit_midi.continue`
6+
`adafruit_midi.midi_continue`
77
================================================================================
88
99
Continue MIDI message.

adafruit_midi/midi_message.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -306,7 +306,7 @@ def __init__(self, status):
306306
class MIDIBadEvent(MIDIMessage):
307307
"""A bad MIDI message, one that could not be parsed/constructed.
308308
309-
:param list data: The MIDI status including any embedded channel number
309+
:param list msg_bytes: The MIDI status including any embedded channel number
310310
and associated subsequent data bytes.
311311
:param Exception exception: The exception used to store the repr() text representation.
312312

adafruit_midi/mtc_quarter_frame.py

+10-8
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,16 @@ class MtcQuarterFrame(MIDIMessage):
2828
"""MIDI Time Code (MTC) Quarter Frame message.
2929
3030
:param msgtype: The quarter frame message type:
31-
- 0: Frame count LS nibble
32-
- 1: Frame count MS nibble
33-
- 2: Seconds count LS nibble
34-
- 3: Seconds count MS nibble
35-
- 4: Minutes count LS nibble
36-
- 5: Minutes count MS nibble
37-
- 6: Hours count LS nibble
38-
- 7: Hours count MS nibble and SMPTE Type
31+
32+
0. Frame count LS nibble
33+
1. Frame count MS nibble
34+
2. Seconds count LS nibble
35+
3. Seconds count MS nibble
36+
4. Minutes count LS nibble
37+
5. Minutes count MS nibble
38+
6. Hours count LS nibble
39+
7. Hours count MS nibble and SMPTE Type
40+
3941
:param value: The quarter frame value for the specified type.
4042
"""
4143

docs/api.rst

+9
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,18 @@
1313
.. automodule:: adafruit_midi.control_change
1414
:members:
1515

16+
.. automodule:: adafruit_midi.control_change_values
17+
:members:
18+
19+
.. automodule:: adafruit_midi.midi_continue
20+
:members:
21+
1622
.. automodule:: adafruit_midi.midi_message
1723
:members:
1824

25+
.. automodule:: adafruit_midi.mtc_quarter_frame
26+
:members:
27+
1928
.. automodule:: adafruit_midi.note_off
2029
:members:
2130

0 commit comments

Comments
 (0)