Skip to content

Commit be0386c

Browse files
authored
Merge branch 'adafruit:main' into main
2 parents e2f4784 + f517203 commit be0386c

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

shared-bindings/keypad/ShiftRegisterKeys.c

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,13 +53,14 @@
5353
//|
5454
//| Key number 0 is the first (or more properly, the zero-th) bit read. In the
5555
//| 74HC165, this bit is labeled ``Q7``. Key number 1 will be the value of ``Q6``, etc.
56-
//| With multiple data pins, key numbers of the next pin are sequentially to the current pin.
56+
//| Key numbers are sequenced such that there are ``key_count[0]`` values read from ``data[0]``, followed by ``key_count[1]`` values read from ``data[1]``, etc.
5757
//|
5858
//| An `EventQueue` is created when this object is created and is available in the `events` attribute.
5959
//|
6060
//| :param microcontroller.Pin clock: The shift register clock pin.
6161
//| The shift register should clock on a low-to-high transition.
62-
//| :param Union[microcontroller.Pin, Sequence[microcontroller.Pin]] data: the incoming shift register data pin(s)
62+
//| :param Union[microcontroller.Pin, Sequence[microcontroller.Pin]] data: the incoming shift register data pin(s).
63+
//| When a ``microcontroller.Pin`` argument is given, it is logically equivalent to a one-element sequence.
6364
//| :param microcontroller.Pin latch:
6465
//| Pin used to latch parallel data going into the shift register.
6566
//| :param bool value_to_latch: Pin state to latch data being read.
@@ -68,6 +69,7 @@
6869
//| The default is ``True``, which is how the 74HC165 operates. The CD4021 latch is the opposite.
6970
//| Once the data is latched, it will be shifted out by toggling the clock pin.
7071
//| :param Union[int, Sequence[int]] key_count: number of data lines to clock in (per data pin)
72+
//| When an ``int`` argument is given, it is logically equivalent to a one-element sequence.
7173
//| :param bool value_when_pressed: ``True`` if the pin reads high when the key is pressed.
7274
//| ``False`` if the pin reads low (is grounded) when the key is pressed.
7375
//| :param float interval: Scan keys no more often than ``interval`` to allow for debouncing.

0 commit comments

Comments
 (0)