Add doc for ev/go

Document that you can pass a function instead of a fiber to ev/go
This commit is contained in:
Locria Cyber 2022-09-14 00:17:53 +00:00
parent e4c9dafc9a
commit ad6a669381
No known key found for this signature in database
GPG Key ID: ED0D424AE4406330
1 changed files with 4 additions and 3 deletions

View File

@ -2687,9 +2687,10 @@ error:
/* C functions */
JANET_CORE_FN(cfun_ev_go,
"(ev/go fiber &opt value supervisor)",
"Put a fiber on the event loop to be resumed later. Optionally pass "
"a value to resume with, otherwise resumes with nil. Returns the fiber. "
"(ev/go fiber-or-fun &opt value supervisor)",
"Put a fiber on the event loop to be resumed later. If a function is used, it is wrapped"
"with `fiber/new` first. "
"Optionally pass a value to resume with, otherwise resumes with nil. Returns the fiber. "
"An optional `core/channel` can be provided as a supervisor. When various "
"events occur in the newly scheduled fiber, an event will be pushed to the supervisor. "
"If not provided, the new fiber will inherit the current supervisor.") {