From a0ea61bc1e934116e4150531aaae56b0556e3fdd Mon Sep 17 00:00:00 2001 From: arofarn Date: Sun, 27 Jun 2021 20:42:13 +0200 Subject: [PATCH] Docstring format --- trellism4_extended.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/trellism4_extended.py b/trellism4_extended.py index 7fb8107..efd02a5 100644 --- a/trellism4_extended.py +++ b/trellism4_extended.py @@ -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 """