summaryrefslogtreecommitdiff
path: root/lib/timeout.rb
diff options
context:
space:
mode:
authorzzak <zzak@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2013-11-10 16:05:04 +0000
committerzzak <zzak@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2013-11-10 16:05:04 +0000
commit12e20b7c4d856dc59c7d9c7959a5a31825325d9d (patch)
tree258d681a04fe3beebcf62a57a692a76780c83093 /lib/timeout.rb
parent5567c5edba5dc107e939d44ce53d8fe88d2fc98d (diff)
* lib/timeout.rb: Added note about change from #8730 [Fixes GH-440]
* NEWS: Improve grammar on change to Timeout Patched by @srawlins in https://github.com/ruby/ruby/pull/440 git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@43640 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/timeout.rb')
-rw-r--r--lib/timeout.rb3
1 files changed, 3 insertions, 0 deletions
diff --git a/lib/timeout.rb b/lib/timeout.rb
index cf46c1db66..ad951d2ffa 100644
--- a/lib/timeout.rb
+++ b/lib/timeout.rb
@@ -57,6 +57,9 @@ module Timeout
# Returns the result of the block *if* the block completed before
# +sec+ seconds, otherwise throws an exception, based on the value of +klass+.
#
+ # The exception thrown to terminate the given block cannot be rescued inside
+ # the block unless +klass+ is given explicitly.
+ #
# Note that this is both a method of module Timeout, so you can <tt>include
# Timeout</tt> into your classes so they have a #timeout method, as well as
# a module method, so you can call it directly as Timeout.timeout().