aboutsummaryrefslogtreecommitdiffstats
path: root/lib/timeout.rb
diff options
context:
space:
mode:
authordrbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2011-06-16 05:24:12 +0000
committerdrbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2011-06-16 05:24:12 +0000
commitdbf9baeddf8679c0dfeb905d720a64e657861675 (patch)
treef7f7e3c48fa07119c4d21e0ea9d2952796951baa /lib/timeout.rb
parentb7528b5edb1f9148ea00ebb6151720e5943b3f0b (diff)
downloadruby-dbf9baeddf8679c0dfeb905d720a64e657861675.tar.gz
* lib/timeout.rb: Clarify timeout duration types. Patch by Alf Mikula.
[Ruby 1.9 - Bug #4791] * lib/net/http.rb: ditto git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@32116 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/timeout.rb')
-rw-r--r--lib/timeout.rb3
1 files changed, 2 insertions, 1 deletions
diff --git a/lib/timeout.rb b/lib/timeout.rb
index 4e4612bf08..91d120a113 100644
--- a/lib/timeout.rb
+++ b/lib/timeout.rb
@@ -36,7 +36,8 @@ module Timeout
# Perform an operation in a block, timing it out if it takes longer
# than +sec+ seconds to complete.
#
- # +sec+:: number of seconds to wait for the block to terminate
+ # +sec+:: Number of seconds to wait for the block to terminate. Any number
+ # may be used, including Floats to specify fractional seconds.
# +klass+:: Exception Class to raise if the block fails to terminate
# in +sec+ seconds. Omitting will use the default, Timeout::Error
#