Bug #4791

Doc: Clarification on allowed timeout values

Added by Alf Mikula almost 3 years ago. Updated over 2 years ago.

[ruby-core:36519]
Status:Closed
Priority:Normal
Assignee:Eric Hodel
Category:doc
Target version:1.9.3
ruby -v:ruby 1.9.3dev (2011-05-11 trunk 31504) [x86_64-darwin10.7.0] Backport:

Description

This patch clarifies what is an acceptable timeout value in Net::HTTP and Timeout::timeout. The existing documentation does not clearly indicate that fractional seconds may be specified, leaving the reader to guess whether only integer values or float values are allowed. Ultimately, Kernel::sleep is called, which accepts any number.

0001-Clarifying-timeout-documentation-to-make-it-clear-th.patch Magnifier (2.03 KB) Alf Mikula, 05/28/2011 08:22 AM

Associated revisions

Revision 32116
Added by Eric Hodel over 2 years ago

  • lib/timeout.rb: Clarify timeout duration types. Patch by Alf Mikula. [Ruby 1.9 - Bug #4791]
    • lib/net/http.rb: ditto

History

#1 Updated by Eric Hodel over 2 years ago

  • Status changed from Open to Closed
  • % Done changed from 0 to 100

This issue was solved with changeset r32116.
Alf, thank you for reporting this issue.
Your contribution to Ruby is greatly appreciated.
May Ruby be with you.

  • lib/timeout.rb: Clarify timeout duration types. Patch by Alf Mikula. [Ruby 1.9 - Bug #4791]
    • lib/net/http.rb: ditto

Also available in: Atom PDF