From 68d59e5538aa9fa87467a8b18724d9f315e969e0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rapha=C3=ABl=20Doursenaud?= Date: Tue, 10 Aug 2021 13:46:59 +0200 Subject: [PATCH] Update documentation --- adafruit_midi/midi_continue.py | 2 +- adafruit_midi/midi_message.py | 2 +- adafruit_midi/mtc_quarter_frame.py | 18 ++++++++++-------- docs/api.rst | 9 +++++++++ 4 files changed, 21 insertions(+), 10 deletions(-) diff --git a/adafruit_midi/midi_continue.py b/adafruit_midi/midi_continue.py index 85ce18c..5cfe342 100644 --- a/adafruit_midi/midi_continue.py +++ b/adafruit_midi/midi_continue.py @@ -3,7 +3,7 @@ # SPDX-License-Identifier: MIT """ -`adafruit_midi.continue` +`adafruit_midi.midi_continue` ================================================================================ Continue MIDI message. diff --git a/adafruit_midi/midi_message.py b/adafruit_midi/midi_message.py index ca0c651..ca609d3 100755 --- a/adafruit_midi/midi_message.py +++ b/adafruit_midi/midi_message.py @@ -306,7 +306,7 @@ def __init__(self, status): class MIDIBadEvent(MIDIMessage): """A bad MIDI message, one that could not be parsed/constructed. - :param list data: The MIDI status including any embedded channel number + :param list msg_bytes: The MIDI status including any embedded channel number and associated subsequent data bytes. :param Exception exception: The exception used to store the repr() text representation. diff --git a/adafruit_midi/mtc_quarter_frame.py b/adafruit_midi/mtc_quarter_frame.py index cdc41f7..6c19420 100644 --- a/adafruit_midi/mtc_quarter_frame.py +++ b/adafruit_midi/mtc_quarter_frame.py @@ -28,14 +28,16 @@ class MtcQuarterFrame(MIDIMessage): """MIDI Time Code (MTC) Quarter Frame message. :param msgtype: The quarter frame message type: - - 0: Frame count LS nibble - - 1: Frame count MS nibble - - 2: Seconds count LS nibble - - 3: Seconds count MS nibble - - 4: Minutes count LS nibble - - 5: Minutes count MS nibble - - 6: Hours count LS nibble - - 7: Hours count MS nibble and SMPTE Type + + 0. Frame count LS nibble + 1. Frame count MS nibble + 2. Seconds count LS nibble + 3. Seconds count MS nibble + 4. Minutes count LS nibble + 5. Minutes count MS nibble + 6. Hours count LS nibble + 7. Hours count MS nibble and SMPTE Type + :param value: The quarter frame value for the specified type. """ diff --git a/docs/api.rst b/docs/api.rst index 0e366f1..535ea83 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -13,9 +13,18 @@ .. automodule:: adafruit_midi.control_change :members: +.. automodule:: adafruit_midi.control_change_values + :members: + +.. automodule:: adafruit_midi.midi_continue + :members: + .. automodule:: adafruit_midi.midi_message :members: +.. automodule:: adafruit_midi.mtc_quarter_frame + :members: + .. automodule:: adafruit_midi.note_off :members: