diff options
| author | usa <usa@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2013-04-02 04:09:07 +0000 |
|---|---|---|
| committer | usa <usa@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2013-04-02 04:09:07 +0000 |
| commit | b6a72bcf2f868bf075d334d05c7522c426db080f (patch) | |
| tree | 9f90665fa4974c8cd5fb23514e6dd41a2211d761 /lib | |
| parent | c921d0e154fe805bd597e1436f264d0d333cfc7e (diff) | |
merge revision(s) 40015: [Backport #8196]
doumentation by @toolmantim [GH fixes #270]
* timeout.rb: Document Timeout::timeout 0 and nil argument behavior
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/branches/ruby_1_9_3@40055 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/timeout.rb | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/lib/timeout.rb b/lib/timeout.rb index 91d120a113..16a168d205 100644 --- a/lib/timeout.rb +++ b/lib/timeout.rb @@ -33,11 +33,12 @@ module Timeout CALLER_OFFSET = ((c = caller[0]) && THIS_FILE =~ c) ? 1 : 0 # :startdoc: - # Perform an operation in a block, timing it out if it takes longer - # than +sec+ seconds to complete. + # Perform an operation in a block, raising an error if it takes longer than + # +sec+ seconds to complete. # # +sec+:: Number of seconds to wait for the block to terminate. Any number - # may be used, including Floats to specify fractional seconds. + # may be used, including Floats to specify fractional seconds. A + # value of 0 or +nil+ will execute the block without any timeout. # +klass+:: Exception Class to raise if the block fails to terminate # in +sec+ seconds. Omitting will use the default, Timeout::Error # |