Skip to content

Commit 2ac4988

Browse files
authored
Merge pull request #1124 from sogaiu/tweak-ev-select-docstring
Tweak ev/select docstring
2 parents 86de039 + cd19dec commit 2ac4988

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

src/core/ev.c

+10-5
Original file line numberDiff line numberDiff line change
@@ -1012,11 +1012,16 @@ static void chan_unlock_args(const Janet *argv, int32_t n) {
10121012

10131013
JANET_CORE_FN(cfun_channel_choice,
10141014
"(ev/select & clauses)",
1015-
"Block until the first of several channel operations occur. Returns a tuple of the form [:give chan], [:take chan x], or [:close chan], where "
1016-
"a :give tuple is the result of a write and :take tuple is the result of a read. Each clause must be either a channel (for "
1017-
"a channel take operation) or a tuple [channel x] for a channel give operation. Operations are tried in order, such that the first "
1018-
"clauses will take precedence over later clauses. Both and give and take operations can return a [:close chan] tuple, which indicates that "
1019-
"the specified channel was closed while waiting, or that the channel was already closed.") {
1015+
"Block until the first of several channel operations occur. Returns a "
1016+
"tuple of the form [:give chan], [:take chan x], or [:close chan], "
1017+
"where a :give tuple is the result of a write and a :take tuple is the "
1018+
"result of a read. Each clause must be either a channel (for a channel "
1019+
"take operation) or a tuple [channel x] (for a channel give operation). "
1020+
"Operations are tried in order such that earlier clauses take "
1021+
"precedence over later clauses. Both give and take operations can "
1022+
"return a [:close chan] tuple, which indicates that the specified "
1023+
"channel was closed while waiting, or that the channel was already "
1024+
"closed.") {
10201025
janet_arity(argc, 1, -1);
10211026
int32_t len;
10221027
const Janet *data;

0 commit comments

Comments
 (0)