diff options
| author | AndrewR-L <59139513+AndrewR-L@users.noreply.github.com> | 2020-04-17 15:10:36 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-04-17 15:10:36 +0100 |
| commit | f572b723060382bbc9ca7a3edc88cb7c30fdcc30 (patch) | |
| tree | 8cd2e66a2fc3d6a4d6e3945d9492dfef60488472 /shared-module/vectorio | |
| parent | 2317fb58732c2e1ae0d2a6c38d6df6e96a3cf7b4 (diff) | |
busio/UART: Correct and clarify readline() return.
Surely readline() "rtype" is string not int as stated (and not bytes as some might expect).
Also it is not totally unambiguous what happens on a timeout so it would help to clarify in docs that on a timeout
it does NOT return with what it has read so far, rather it leaves all that in the buffer ready for a future read and returns nothing.
Likewise clarify that if timeout=0 but there is no newline it DOES return what it has read so far (NOT None).
At least this is what I think it does and/or is supposed to do!
Python docs are generally not too explicit about what is the proper treatment, so perhaps all the more reason to
clarify the interpretation adopted?
Diffstat (limited to 'shared-module/vectorio')
0 files changed, 0 insertions, 0 deletions
