Skip to content

Update documentation #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 15, 2021
Merged

Update documentation #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion adafruit_midi/midi_continue.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# SPDX-License-Identifier: MIT

"""
`adafruit_midi.continue`
`adafruit_midi.midi_continue`
================================================================================

Continue MIDI message.
Expand Down
2 changes: 1 addition & 1 deletion adafruit_midi/midi_message.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
18 changes: 10 additions & 8 deletions adafruit_midi/mtc_quarter_frame.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
"""

Expand Down
9 changes: 9 additions & 0 deletions docs/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down