Skip to content

Commit 1c3a274

Browse files
committed
Clarify further; fix type error
1 parent 1a6c021 commit 1c3a274

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

shared-bindings/usb_cdc/Serial.c

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -63,13 +63,13 @@
6363
//| :rtype: bytes"""
6464
//| ...
6565
//|
66-
//| def readline(self, size=-1) -> Optional[bytes]:
67-
//| r"""Read a line, ending in a newline character ("\\n"), or
68-
//| return everything readable if no newline is found and ``timeout`` is 0.
66+
//| def readline(self, size: int = -1) -> Optional[bytes]:
67+
//| r"""Read a line ending in a newline character ("\\n"), including the newline.
68+
//| Return everything readable if no newline is found and ``timeout`` is 0.
6969
//| Return ``None`` in case of error.
7070
//|
7171
//| 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.
72+
//| If the host computer transmits "\\r" it will also be included as part of the line.
7373
//|
7474
//| :param int size: maximum number of characters to read. ``-1`` means as many as possible.
7575
//| :return: the line read

0 commit comments

Comments
 (0)