Skip to content

Commit 4f04cee

Browse files
authored
Merge pull request #6283 from Neradoc/nera-fix-keypad-doc
Fixes to keypad docs
2 parents 7be66a5 + 3c111ba commit 4f04cee

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

shared-bindings/keypad/Event.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
//| def __init__(self, key_number: int=0, pressed: bool=True, timestamp:Optional[int]=None) -> None:
3737
//| """Create a key transition event, which reports a key-pressed or key-released transition.
3838
//|
39-
//| :param int key_number: the key number
39+
//| :param int key_number: The key number.
4040
//| :param bool pressed: ``True`` if the key was pressed; ``False`` if it was released.
4141
//| :param int timestamp: The time in milliseconds that the keypress occurred in the `supervisor.ticks_ms` time system. If specified as None, the current value of `supervisor.ticks_ms` is used.
4242
//| """
@@ -120,7 +120,7 @@ const mp_obj_property_t keypad_event_released_obj = {
120120
};
121121

122122
//| timestamp: int
123-
//| """The timestamp"""
123+
//| """The timestamp."""
124124
//|
125125
STATIC mp_obj_t keypad_event_get_timestamp(mp_obj_t self_in) {
126126
keypad_event_obj_t *self = MP_OBJ_TO_PTR(self_in);

shared-bindings/keypad/EventQueue.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
//| If a new event arrives when the queue is full, the event is discarded, and
4646
//| `overflowed` is set to ``True``.
4747
//|
48-
//| :return: the next queued key transition `Event`
48+
//| :return: The next queued key transition `Event`.
4949
//| :rtype: Optional[Event]
5050
//| """
5151
//| ...

shared-bindings/keypad/KeyMatrix.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ STATIC void check_for_deinit(keypad_keymatrix_obj_t *self) {
157157
//| """
158158
//|
159159

160-
//| def key_number_to_row_column(self, row: int, column: int) -> Tuple[int]:
160+
//| def key_number_to_row_column(self, key_number: int) -> Tuple[int]:
161161
//| """Return the row and column for the given key number.
162162
//| The row is ``key_number // len(column_pins)``.
163163
//| The column is ``key_number % len(column_pins)``.

0 commit comments

Comments
 (0)