Skip to content

Commit 561ed37

Browse files
committed
fix the docstrings
1 parent 34427bd commit 561ed37

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

ports/raspberrypi/bindings/rp2pio/StateMachine.c

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -378,7 +378,7 @@ STATIC mp_obj_t rp2pio_statemachine_stop(mp_obj_t self_obj) {
378378
}
379379
MP_DEFINE_CONST_FUN_OBJ_1(rp2pio_statemachine_stop_obj, rp2pio_statemachine_stop);
380380

381-
//| def write(self, buffer: ReadableBuffer, *, start: int = 0, end: Optional[int] = None, swap bool = False) -> None:
381+
//| def write(self, buffer: ReadableBuffer, *, start: int = 0, end: Optional[int] = None, swap: bool = False) -> None:
382382
//| """Write the data contained in ``buffer`` to the state machine. If the buffer is empty, nothing happens.
383383
//|
384384
//| Writes to the FIFO will match the input buffer's element size. For example, bytearray elements
@@ -390,7 +390,7 @@ MP_DEFINE_CONST_FUN_OBJ_1(rp2pio_statemachine_stop_obj, rp2pio_statemachine_stop
390390
//|
391391
//| :param ~circuitpython_typing.ReadableBuffer buffer: Write out the data in this buffer
392392
//| :param int start: Start of the slice of ``buffer`` to write out: ``buffer[start:end]``
393-
//| :param int end: End of the slice; this index is not included. Defaults to ``len(buffer)``"""
393+
//| :param int end: End of the slice; this index is not included. Defaults to ``len(buffer)``
394394
//| :param bool swap: For 2- and 4-byte elements, swap (reverse) the byte order"""
395395
//| ...
396396
//|
@@ -463,7 +463,7 @@ MP_DEFINE_CONST_FUN_OBJ_KW(rp2pio_statemachine_write_obj, 2, rp2pio_statemachine
463463
//|
464464
//| Having neither ``once`` nor ``loop`` terminates an existing
465465
//| background looping write after exactly a whole loop. This is in contrast to
466-
//| `stop_background_write, which interrupts an ongoing DMA operation.
466+
//| `stop_background_write`, which interrupts an ongoing DMA operation.
467467
//|
468468
//| :param ~Optional[circuitpython_typing.ReadableBuffer] once: Data to be written once
469469
//| :param ~Optional[circuitpython_typing.ReadableBuffer] loop: Data to be written repeatedly
@@ -577,7 +577,7 @@ const mp_obj_property_t rp2pio_statemachine_pending_obj = {
577577
MP_ROM_NONE},
578578
};
579579

580-
//| def readinto(self, buffer: WriteableBuffer, *, start: int = 0, end: Optional[int] = None, bool swap) -> None:
580+
//| def readinto(self, buffer: WriteableBuffer, *, start: int = 0, end: Optional[int] = None, swap: bool=False) -> None:
581581
//| """Read into ``buffer``. If the number of bytes to read is 0, nothing happens. The buffer
582582
//| includes any data added to the fifo even if it was added before this was called.
583583
//|
@@ -650,8 +650,8 @@ MP_DEFINE_CONST_FUN_OBJ_KW(rp2pio_statemachine_readinto_obj, 2, rp2pio_statemach
650650
//| :param int out_start: Start of the slice of buffer_out to write out: ``buffer_out[out_start:out_end]``
651651
//| :param int out_end: End of the slice; this index is not included. Defaults to ``len(buffer_out)``
652652
//| :param int in_start: Start of the slice of ``buffer_in`` to read into: ``buffer_in[in_start:in_end]``
653-
//| :param int in_end: End of the slice; this index is not included. Defaults to ``len(buffer_in)``"""
654-
//| :param bool swap_out: For 2- and 4-byte elements, swap (reverse) the byte order for the buffer being transmitted (written)"""
653+
//| :param int in_end: End of the slice; this index is not included. Defaults to ``len(buffer_in)``
654+
//| :param bool swap_out: For 2- and 4-byte elements, swap (reverse) the byte order for the buffer being transmitted (written)
655655
//| :param bool swap_in: For 2- and 4-rx elements, swap (reverse) the byte order for the buffer being received (read)"""
656656
//| ...
657657
//|

0 commit comments

Comments
 (0)