From 892880b4190fa8d22ca9b34bbcf8d3b81ea7d7ae Mon Sep 17 00:00:00 2001
From: ocelot-inc <pgulutzan@ocelot.ca>
Date: Tue, 30 Sep 2014 18:35:47 -0600
Subject: [PATCH] improve documentation of fiber
---
doc/user/stored-procedures.xml | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/doc/user/stored-procedures.xml b/doc/user/stored-procedures.xml
index f915ba9285..1aa26a9ebd 100644
--- a/doc/user/stored-procedures.xml
+++ b/doc/user/stored-procedures.xml
@@ -978,9 +978,12 @@ procedures.
<para>
Cancel a <code>fiber</code>.
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>
- Parameters: <code>fiber</code> = the fiber to be canceled.
+ Parameters: fiber object, for example the fiber returned by <code>fiber.create</code>.
</para>
<para>
Possible errors: the specified fiber does not permit cancel.
--
GitLab