usb_cdc.serial.read() doc says it reads one byte, but it will read as much as possible #9365
Comments
|
There are complaints about pyserial's
I'm now thinking we may not necessarily want to mimic pyserial so closely. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Right now the documentation for
usb_cdc.serial.read()gives the signature asusb_cdc.serial.read(size = 1). That is, it reads a at most a single byte. This does not match the implementation: it actually tries to read as much as possible, because it uses the standard stream operationread(), which has those semantics.Pyserial's
read()has the same signature and does read only one byte if no argument is given. I think our original intention was to match pyserial.So rather than change the documentation, we should probably fix the implementation.
The text was updated successfully, but these errors were encountered: