arofarn/CircuitPython_TrellisM4_extended
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Docstring format

Browse Source
This commit is contained in:
arofarn 2021-06-27 20:42:13 +02:00
parent 98da60f350
commit a0ea61bc1e
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
trellism4_extended.py
View File

@ -163,12 +163,15 @@ class _TrellisKeypad:
class NeoTrellisM4:
"""
Driver for the Adafruit NeoTrellis
Driver for the Adafruit NeoTrellis.
:param left_part: if None (or ommitted) the class create a
neotrellis.multitrellis-compatible object for the left half of the
TrellisM4 board. Else le right part is created and the arguement
should be the left part object.
Example:
.. code-block:: python
from neotrellism4 import NeoTrellisM4
@ -234,6 +237,7 @@ class NeoTrellisM4:
def set_event(self, key, edge, enable):
"""
Control which kinds of events are set
:param int key: the key number
:param int edge: the type of event
:param bool enable: True to enable the event, False to disable it
@ -253,6 +257,7 @@ class NeoTrellisM4:
def read_keypad(self, num):
"""
Read data from the keypad
:param int num: The number of bytes to read
"""