summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--ChangeLog5
-rw-r--r--cont.c26
2 files changed, 31 insertions, 0 deletions
diff --git a/ChangeLog b/ChangeLog
index 25c0dc631d..7a55269f82 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+Wed May 2 19:06:30 2012 Ayumu AIZAWA <ayumu.aizawa@gmail.com>
+
+ * cont.c (rb_fiber_m_transfer): Improved Fiber documentation.
+ patched by Anuj Dutta. [ruby-core:44540][Bug #6343]
+
Wed May 2 13:06:37 2012 Nobuyoshi Nakada <nobu@ruby-lang.org>
* README, README.ja: reformatted using rdoc markup. based on the
diff --git a/cont.c b/cont.c
index 97602ad2f1..d900d5a3c9 100644
--- a/cont.c
+++ b/cont.c
@@ -1425,6 +1425,32 @@ rb_fiber_m_resume(int argc, VALUE *argv, VALUE fib)
* You cannot resume a fiber that transferred control to another one.
* This will cause a double resume error. You need to transfer control
* back to this fiber before it can yield and resume.
+ *
+ * Example:
+ *
+ * fiber1 = Fiber.new do
+ * puts "In Fiber 1"
+ * Fiber.yield
+ * end
+ *
+ * fiber2 = Fiber.new do
+ * puts "In Fiber 2"
+ * fiber1.transfer
+ * end
+ *
+ * fiber3 = Fiber.new do
+ * puts "In Fiber 3"
+ * end
+ *
+ * fiber2.resume
+ * fiber3.resume
+ *
+ * <em>produces</em>
+ *
+ * I am in fiber2
+ * I am in fiber1
+ * I am in fiber3
+ *
*/
static VALUE
rb_fiber_m_transfer(int argc, VALUE *argv, VALUE fibval)