Skip to content

Commit f5c4bca

Browse files
committed
StreamReader.readinto: document, strip debug and repeated comments.
1 parent 7580e7b commit f5c4bca

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

FASTPOLL.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -393,11 +393,13 @@ method.
393393
`StreamReader.readinto(buf, n=0)` args:
394394
`buf` the buffer to read into.
395395
`n=0` the maximum number of bytes to read - default the buffer size.
396-
available it will be placed in the buffer. The return value is the number of
397-
bytes read. The default maximum is the buffer size, otherwise the value of `n`.
398396

399397
The method will pause (allowing other coros to run) until data is available.
400398

399+
Available data will be placed in the buffer. The return value is the number of
400+
bytes read. The default maximum number of bytes is limited to the buffer size,
401+
otherwise to the value of `n`.
402+
401403
This method calls the synchronous `readinto` method of the data source. This
402404
may take one arg (the buffer) or two (the buffer followed by the maximum number
403405
of bytes to read). If `StreamReader.readinto` is launched with a single arg,

0 commit comments

Comments
 (0)