Skip to content

Commit 8f1a4fd

Browse files
committed
Fix documentation
1 parent 88b4e38 commit 8f1a4fd

File tree

1 file changed

+4
-8
lines changed

1 file changed

+4
-8
lines changed

shared-bindings/keypaddemux/DemuxKeyMatrix.c

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -67,13 +67,13 @@
6767
//| The keys are numbered sequentially from zero. A key number can be computed
6868
//| by ``row * len(column_pins) + column``.
6969
//|
70-
//| An `EventQueue` is created when this object is created and is available in the `events` attribute.
70+
//| An `keypad.EventQueue` is created when this object is created and is available in the `events` attribute.
7171
//|
7272
//| :param Sequence[microcontroller.Pin] row_addr_pins: The pins attached to the rows demultiplexer.
7373
//| :param Sequence[microcontroller.Pin] column_pins: The pins attached to the columns.
7474
//| :param float interval: Scan keys no more often than ``interval`` to allow for debouncing.
7575
//| ``interval`` is in float seconds. The default is 0.020 (20 msecs).
76-
//| :param int max_events: maximum size of `events` `EventQueue`:
76+
//| :param int max_events: maximum size of `events` `keypad.EventQueue`:
7777
//| maximum number of key transition events that are saved.
7878
//| Must be >= 1.
7979
//| If a new event arrives when the queue is full, the oldest event is discarded.
@@ -134,7 +134,7 @@ STATIC mp_obj_t keypad_demux_demuxkeymatrix_deinit(mp_obj_t self_in) {
134134
}
135135
MP_DEFINE_CONST_FUN_OBJ_1(keypad_demux_demuxkeymatrix_deinit_obj, keypad_demux_demuxkeymatrix_deinit);
136136

137-
//| def __enter__(self) -> KeyMatrix:
137+
//| def __enter__(self) -> DemuxKeyMatrix:
138138
//| """No-op used by Context Managers."""
139139
//| ...
140140
// Provided by context manager helper.
@@ -202,6 +202,7 @@ MP_DEFINE_CONST_FUN_OBJ_2(keypad_demux_demuxkeymatrix_key_number_to_row_column_o
202202
//| The key number is ``row * len(column_pins) + column``.
203203
//| """
204204
//| ...
205+
//|
205206
STATIC mp_obj_t keypad_demux_demuxkeymatrix_row_column_to_key_number(mp_obj_t self_in, mp_obj_t row_in, mp_obj_t column_in) {
206207
keypad_demux_demuxkeymatrix_obj_t *self = MP_OBJ_TO_PTR(self_in);
207208
check_for_deinit(self);
@@ -217,11 +218,6 @@ STATIC mp_obj_t keypad_demux_demuxkeymatrix_row_column_to_key_number(mp_obj_t se
217218
}
218219
MP_DEFINE_CONST_FUN_OBJ_3(keypad_demux_demuxkeymatrix_row_column_to_key_number_obj, keypad_demux_demuxkeymatrix_row_column_to_key_number);
219220

220-
//| events: EventQueue
221-
//| """The `EventQueue` associated with this `Keys` object. (read-only)
222-
//| """
223-
//|
224-
225221
STATIC const mp_rom_map_elem_t keypad_demux_demuxkeymatrix_locals_dict_table[] = {
226222
{ MP_ROM_QSTR(MP_QSTR_deinit), MP_ROM_PTR(&keypad_demux_demuxkeymatrix_deinit_obj) },
227223
{ MP_ROM_QSTR(MP_QSTR___enter__), MP_ROM_PTR(&default___enter___obj) },

0 commit comments

Comments
 (0)