djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #6283 from Neradoc/nera-fix-keypad-doc

Browse Source 
Fixes to keypad docs
This commit is contained in:
Mark 2022-04-16 17:45:28 -05:00 committed by GitHub
commit 4f04cee729
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
shared-bindings/keypad/Event.c
View File

@ -36,7 +36,7 @@
//| def __init__(self, key_number: int=0, pressed: bool=True, timestamp:Optional[int]=None) -> None: //| def __init__(self, key_number: int=0, pressed: bool=True, timestamp:Optional[int]=None) -> None:
//| """Create a key transition event, which reports a key-pressed or key-released transition. //| """Create a key transition event, which reports a key-pressed or key-released transition.
//| //|
//| :param int key_number: the key number //| :param int key_number: The key number.
//| :param bool pressed: ``True`` if the key was pressed; ``False`` if it was released. //| :param bool pressed: ``True`` if the key was pressed; ``False`` if it was released.
//| :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. //| :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.
//| """ //| """
@ -120,7 +120,7 @@ const mp_obj_property_t keypad_event_released_obj = {
}; };
//| timestamp: int //| timestamp: int
//| """The timestamp""" //| """The timestamp."""
//| //|
STATIC mp_obj_t keypad_event_get_timestamp(mp_obj_t self_in) { STATIC mp_obj_t keypad_event_get_timestamp(mp_obj_t self_in) {
keypad_event_obj_t *self = MP_OBJ_TO_PTR(self_in); keypad_event_obj_t *self = MP_OBJ_TO_PTR(self_in);

2
shared-bindings/keypad/EventQueue.c
View File

@ -45,7 +45,7 @@
//| If a new event arrives when the queue is full, the event is discarded, and //| If a new event arrives when the queue is full, the event is discarded, and
//| `overflowed` is set to ``True``. //| `overflowed` is set to ``True``.
//| //|
//| :return: the next queued key transition `Event` //| :return: The next queued key transition `Event`.
//| :rtype: Optional[Event] //| :rtype: Optional[Event]
//| """ //| """
//| ... //| ...

2
shared-bindings/keypad/KeyMatrix.c
View File

@ -157,7 +157,7 @@ STATIC void check_for_deinit(keypad_keymatrix_obj_t *self) {
//| """ //| """
//| //|
//| def key_number_to_row_column(self, row: int, column: int) -> Tuple[int]: //| def key_number_to_row_column(self, key_number: int) -> Tuple[int]:
//| """Return the row and column for the given key number. //| """Return the row and column for the given key number.
//| The row is ``key_number // len(column_pins)``. //| The row is ``key_number // len(column_pins)``.
//| The column is ``key_number % len(column_pins)``. //| The column is ``key_number % len(column_pins)``.