Skip to content
Snippets Groups Projects
Commit 892880b4 authored by ocelot-inc's avatar ocelot-inc
Browse files

improve documentation of fiber

parent b98ec0a1
No related branches found
No related tags found
No related merge requests found
...@@ -978,9 +978,12 @@ procedures. ...@@ -978,9 +978,12 @@ procedures.
<para> <para>
Cancel a <code>fiber</code>. Cancel a <code>fiber</code>.
Running and suspended fibers can be canceled. Running and suspended fibers can be canceled.
After a fiber has been canceled, attempts to operate on it will cause errors,
for example <code>fiber.id(<replaceable>fiber</replaceable>)</code> will cause
"error: the fiber is dead".
</para> </para>
<para> <para>
Parameters: <code>fiber</code> = the fiber to be canceled. Parameters: fiber object, for example the fiber returned by <code>fiber.create</code>.
</para> </para>
<para> <para>
Possible errors: the specified fiber does not permit cancel. Possible errors: the specified fiber does not permit cancel.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment