1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[ruby/timeout] updated doc and kept the nil compatiability

Browse Source 
https://github.com/ruby/timeout/commit/f992632cf3
This commit is contained in:
CosmicOppai 2024-10-18 01:08:38 +05:30 committed by git
parent e7dd185e21
commit b156efc2a6
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
lib/timeout.rb
View File

@ -141,9 +141,10 @@ module Timeout
# Perform an operation in a block, raising an error if it takes longer than # Perform an operation in a block, raising an error if it takes longer than
# +sec+ seconds to complete. # +sec+ seconds to complete.
# #
# +sec+:: Number of seconds to wait for the block to terminate. Any number # +sec+:: Number of seconds to wait for the block to terminate. Any non-negative number
# may be used, including Floats to specify fractional seconds. A # or nil may be used, including Floats to specify fractional seconds. A
# value of 0 or +nil+ will execute the block without any timeout. # value of 0 or +nil+ will execute the block without any timeout.
# Any negative value will raise the ArgumentError
# +klass+:: Exception Class to raise if the block fails to terminate # +klass+:: Exception Class to raise if the block fails to terminate
# in +sec+ seconds. Omitting will use the default, Timeout::Error # in +sec+ seconds. Omitting will use the default, Timeout::Error
# +message+:: Error message to raise with Exception Class. # +message+:: Error message to raise with Exception Class.
@ -164,8 +165,8 @@ module Timeout
# Timeout</tt> into your classes so they have a #timeout method, as well as # 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(). # a module method, so you can call it directly as Timeout.timeout().
def timeout(sec, klass = nil, message = nil, &block) #:yield: +sec+ def timeout(sec, klass = nil, message = nil, &block) #:yield: +sec+
raise ArgumentError, "Timeout sec must be a positive number" unless sec.is_a?(Numeric) && sec >= 0 raise ArgumentError, "Timeout sec must be a non-negative number" if sec && !(sec.is_a?(Numeric) && sec >= 0)
return yield(sec) if sec.zero? return yield(sec) if sec == nil or sec.zero?
message ||= "execution expired" message ||= "execution expired"