Skip to content

Commit 1a6c021

Browse files
committed
Add clarifying comment re carriage-return char.
1 parent a6cb7d7 commit 1a6c021

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

shared-bindings/usb_cdc/Serial.c

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,8 @@
6868
//| return everything readable if no newline is found and ``timeout`` is 0.
6969
//| Return ``None`` in case of error.
7070
//|
71-
//| This is a binary stream: the newline character cannot be changed.
71+
//| This is a binary stream: the newline character "\\n" cannot be changed.
72+
//| If the host computer transmits "\\r" it will be included as part of the line.
7273
//|
7374
//| :param int size: maximum number of characters to read. ``-1`` means as many as possible.
7475
//| :return: the line read

0 commit comments

Comments
 (0)