Skip to content

Commit

Permalink
updated doc and kept the nil compatiability
Browse files Browse the repository at this point in the history
  • Loading branch information
Cosmicoppai committed Oct 17, 2024
1 parent ffc8d7c commit f992632
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions lib/timeout.rb
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,10 @@ def self.ensure_timeout_thread_created
# 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. A
# +sec+:: Number of seconds to wait for the block to terminate. Any non-negative number
# or nil may be used, including Floats to specify fractional seconds. A
# 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
# in +sec+ seconds. Omitting will use the default, Timeout::Error
# +message+:: Error message to raise with Exception Class.
Expand All @@ -164,8 +165,8 @@ def self.ensure_timeout_thread_created
# 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().
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
return yield(sec) if sec.zero?
raise ArgumentError, "Timeout sec must be a non-negative number" if sec && !(sec.is_a?(Numeric) && sec >= 0)
return yield(sec) if sec == nil or sec.zero?

message ||= "execution expired"

Expand Down

0 comments on commit f992632

Please sign in to comment.