Skip to content

Commit

Permalink
Improve Fiber#kill docs and simplify the NEWS entry to let the docume…
Browse files Browse the repository at this point in the history
…ntation explain
  • Loading branch information
eregon committed Dec 8, 2023
1 parent 7d05277 commit 0204523
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 3 deletions.
2 changes: 1 addition & 1 deletion NEWS.md
Expand Up @@ -40,7 +40,7 @@ Note: We're only listing outstanding class updates.

* Fiber

* Introduce Fiber#kill, similar to Thread#kill. [[Bug #595]]
* Introduce Fiber#kill. [[Bug #595]]
```ruby
fiber = Fiber.new do
while true
Expand Down
12 changes: 10 additions & 2 deletions cont.c
Expand Up @@ -3259,6 +3259,8 @@ rb_fiber_raise(VALUE fiber, int argc, const VALUE *argv)
* the exception, and the third parameter is an array of callback information.
* Exceptions are caught by the +rescue+ clause of <code>begin...end</code>
* blocks.
*
* Raises +FiberError+ if called on a Fiber belonging to another +Thread+.
*/
static VALUE
rb_fiber_m_raise(int argc, VALUE *argv, VALUE self)
Expand All @@ -3270,12 +3272,18 @@ rb_fiber_m_raise(int argc, VALUE *argv, VALUE self)
* call-seq:
* fiber.kill -> nil
*
* Terminates +fiber+ by raising an uncatchable exception, returning
* the terminated Fiber.
* Terminates +fiber+ by raising an uncatchable exception.
* It only terminates the given Fiber and no other Fiber, returning +nil+ to
* another Fiber if that Fiber was calling +fiber.resume+ or +fiber.transfer+.
*
* +Fiber#kill+ only interrupts another Fiber when it is in +Fiber.yield+.
* If called on the current Fiber then it raises that exception at the +Fiber#kill+ call site.
*
* If the fiber has not been started, transition directly to the terminated state.
*
* If the fiber is already terminated, does nothing.
*
* Raises +FiberError+ if called on a Fiber belonging to another +Thread+.
*/
static VALUE
rb_fiber_m_kill(VALUE self)
Expand Down

0 comments on commit 0204523

Please sign in to comment.