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

net.nim: minor documentation update

Browse source
This commit is contained in:
Andreas Rumpf 2018-01-07 12:20:00 +01:00
commit 08af53032b
1 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
lib/pure/net.nim
View file

@ -1135,11 +1135,11 @@ proc recv*(socket: Socket, data: var string, size: int, timeout = -1,
## ##
## When 0 is returned the socket's connection has been closed. ## When 0 is returned the socket's connection has been closed.
## ##
## This function will throw an EOS exception when an error occurs. A value ## This function will throw an OSError exception when an error occurs. A value
## lower than 0 is never returned. ## lower than 0 is never returned.
## ##
## 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 an ETimeout exception will be raised. ## within the time specified an TimeoutError exception will be raised.
## ##
## **Note**: ``data`` must be initialised. ## **Note**: ``data`` must be initialised.
## ##