mirrors/janet
1
0
Fork 0
mirror of https://github.com/janet-lang/janet synced 2024-12-26 08:20:27 +00:00
Code Issues 1 Releases Wiki Activity

Update documentation for net/read and net/chunk.

Browse Source
This commit is contained in:
Calvin Rose 2020-04-27 19:25:28 -05:00
parent 6b0f93ce8a
commit c98e1f3cae
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/core/net.c
View File

@ -685,14 +685,14 @@ static const JanetReg net_cfuns[] = {
{
"net/read", cfun_stream_read,
JDOC("(net/read stream nbytes &opt buf)\n\n"
"Read n bytes from a stream, suspending the current fiber until the bytes are available. "
"Returns a buffer with n more bytes in it.")
"Read up to n bytes from a stream, suspending the current fiber until the bytes are available. "
"If less than n bytes are available (and more than 0), will push those bytes and return early. "
"Returns a buffer with up to n more bytes in it.")
},
{
"net/chunk", cfun_stream_chunk,
JDOC("(net/chunk stream nbytes &opt buf)\n\n"
"Same a net/read, but will return as soon as any data is available "
"rather than wait for all n bytes to arrive.")
"Same a net/read, but will wait for all n bytes to arrive rather than return early.")
},
{
"net/write", cfun_stream_write,