aboutsummaryrefslogtreecommitdiffstats
path: root/lib/timeout.rb
diff options
context:
space:
mode:
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
#