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

Merge pull request from tekktrik/dev/fix-uart-docs

Browse Source 
Fix UART documentation
This commit is contained in:
MicroDev 2022-09-01 13:08:34 +05:30 committed by GitHub
commit b1371ceb62
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 3 deletions

7
shared-bindings/busio/UART.c

@ -222,15 +222,16 @@ STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(busio_uart___exit___obj, 4, 4, busio_
//| def readline(self) -> bytes: //| def readline(self) -> bytes:
//| """Read a line, ending in a newline character, or //| """Read a line, ending in a newline character, or
//| return None if a timeout occurs sooner, or //| return ``None`` if a timeout occurs sooner, or
//| return everything readable if no newline is found and timeout=0 //| return everything readable if no newline is found and
//| ``timeout=0``
//| //|
//| :return: the line read //| :return: the line read
//| :rtype: bytes or None""" //| :rtype: bytes or None"""
//| ... //| ...
//| //|
//| def write(self, buf: WriteableBuffer) -> Optional[int]: //| def write(self, buf: ReadableBuffer) -> Optional[int]:
//| """Write the buffer of bytes to the bus. //| """Write the buffer of bytes to the bus.
//| //|
//| *New in CircuitPython 4.0:* ``buf`` must be bytes, not a string. //| *New in CircuitPython 4.0:* ``buf`` must be bytes, not a string.