mirror of
https://github.com/status-im/nim-chronos.git
synced 2025-01-18 23:31:13 +00:00
Fix documentation for read(n) procedure.
This commit is contained in:
parent
317ce3c797
commit
49bae9792d
@ -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)
|
||||
|
Loading…
x
Reference in New Issue
Block a user