jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Small doc fixes in net (#17566)

Browse source
This commit is contained in:
Danil Yarantsev 2021-03-29 14:06:23 +03:00 • committed by GitHub
commit 89e0e0f27f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

6
lib/pure/net.nim
View file

@ -1427,7 +1427,7 @@ proc recv*(socket: Socket, data: var string, size: int, timeout = -1,
flags = {SocketFlag.SafeDisconn}): int = flags = {SocketFlag.SafeDisconn}): int =
## Higher-level version of `recv`. ## Higher-level version of `recv`.
## ##
## Reads **up to** `size` bytes from `socket` into `buf`. ## Reads **up to** `size` bytes from `socket` into `data`.
## ##
## For buffered sockets this function will attempt to read all the requested ## For buffered sockets this function will attempt to read all the requested
## data. It will read this data in `BufferSize` chunks. ## data. It will read this data in `BufferSize` chunks.
@ -1444,8 +1444,6 @@ proc recv*(socket: Socket, data: var string, size: int, timeout = -1,
## A timeout may be specified in milliseconds, if enough data is not received ## A timeout may be specified in milliseconds, if enough data is not received
## within the time specified a TimeoutError exception will be raised. ## within the time specified a TimeoutError exception will be raised.
## ##
## **Note**: `data` must be initialised.
##
## .. warning:: Only the `SafeDisconn` flag is currently supported. ## .. warning:: Only the `SafeDisconn` flag is currently supported.
data.setLen(size) data.setLen(size)
result = result =
@ -1464,7 +1462,7 @@ proc recv*(socket: Socket, size: int, timeout = -1,
flags = {SocketFlag.SafeDisconn}): string {.inline.} = flags = {SocketFlag.SafeDisconn}): string {.inline.} =
## Higher-level version of `recv` which returns a string. ## Higher-level version of `recv` which returns a string.
## ##
## Reads **up to** `size` bytes from `socket` into `buf`. ## Reads **up to** `size` bytes from `socket` into the result.
## ##
## For buffered sockets this function will attempt to read all the requested ## For buffered sockets this function will attempt to read all the requested
## data. It will read this data in `BufferSize` chunks. ## data. It will read this data in `BufferSize` chunks.