Skip to content

Commit b1371ce

Browse files
authored
Merge pull request #6846 from tekktrik/dev/fix-uart-docs
Fix UART documentation
2 parents d644629 + 0d8dab7 commit b1371ce

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

shared-bindings/busio/UART.c

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -222,15 +222,16 @@ STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(busio_uart___exit___obj, 4, 4, busio_
222222

223223
//| def readline(self) -> bytes:
224224
//| """Read a line, ending in a newline character, or
225-
//| return None if a timeout occurs sooner, or
226-
//| return everything readable if no newline is found and timeout=0
225+
//| return ``None`` if a timeout occurs sooner, or
226+
//| return everything readable if no newline is found and
227+
//| ``timeout=0``
227228
//|
228229
//| :return: the line read
229230
//| :rtype: bytes or None"""
230231
//| ...
231232
//|
232233

233-
//| def write(self, buf: WriteableBuffer) -> Optional[int]:
234+
//| def write(self, buf: ReadableBuffer) -> Optional[int]:
234235
//| """Write the buffer of bytes to the bus.
235236
//|
236237
//| *New in CircuitPython 4.0:* ``buf`` must be bytes, not a string.

0 commit comments

Comments
 (0)