diff --git a/ChangeLog b/ChangeLog index 1a4d97ee8a..753b619c8c 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,9 @@ +Thu Jun 16 14:15:47 2011 Eric Hodel + + * lib/timeout.rb: Clarify timeout duration types. Patch by Alf Mikula. + [Ruby 1.9 - Bug #4791] + * lib/net/http.rb: ditto + Thu Jun 16 13:25:25 2011 Eric Hodel * lib/rdoc*: Import RDoc 3.7 release candidate diff --git a/lib/net/http.rb b/lib/net/http.rb index 36fb418777..045967caa3 100644 --- a/lib/net/http.rb +++ b/lib/net/http.rb @@ -619,13 +619,15 @@ module Net #:nodoc: # The port number to connect to. attr_reader :port - # Number of seconds to wait for the connection to open. - # If the HTTP object cannot open a connection in this many seconds, - # it raises a TimeoutError exception. + # Number of seconds to wait for the connection to open. Any number + # may be used, including Floats for fractional seconds. If the HTTP + # object cannot open a connection in this many seconds, it raises a + # TimeoutError exception. attr_accessor :open_timeout # Number of seconds to wait for one block to be read (via one read(2) - # call). If the HTTP object cannot read data in this many seconds, + # call). Any number may be used, including Floats for fractional + # seconds. If the HTTP object cannot read data in this many seconds, # it raises a TimeoutError exception. attr_reader :read_timeout 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 #