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

Add clarifying comment re carriage-return char.

Browse Source
This commit is contained in:
Dan Halbert 2021-03-07 17:04:27 -05:00
parent a6cb7d7069
commit 1a6c021239
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
shared-bindings/usb_cdc/Serial.c
View File

@ -68,7 +68,8 @@
//| return everything readable if no newline is found and ``timeout`` is 0.
//| Return ``None`` in case of error.
//|
//| This is a binary stream: the newline character cannot be changed.
//| This is a binary stream: the newline character "\\n" cannot be changed.
//| If the host computer transmits "\\r" it will be included as part of the line.
//|
//| :param int size: maximum number of characters to read. ``-1`` means as many as possible.
//| :return: the line read