codex-storage
/
nim-chronos
mirror of https://github.com/codex-storage/nim-chronos.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix documentation for read(n) procedure.

This commit is contained in:
cheatfate 2019-05-28 20:12:00 +03:00
parent 317ce3c797
commit 49bae9792d
No known key found for this signature in database
GPG Key ID: 46ADD633A7201F95
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
chronos/transports/stream.nim
View File

@ -1642,7 +1642,7 @@ proc readLine*(transp: StreamTransport, limit = 0,
await fut
proc read*(transp: StreamTransport, n = -1): Future[seq[byte]] {.async.} =
## Read all bytes (n == -1) or exactly `n` bytes from transport ``transp``.
## Read all bytes (n <= 0) or exactly `n` bytes from transport ``transp``.
##
## This procedure allocates buffer seq[byte] and return it as result.
checkClosed(transp)