Project

General

Profile

Bug #4791

Doc: Clarification on allowed timeout values

Added by amikula (Alf Mikula) about 7 years ago. Updated about 7 years ago.

Status:
Closed
Priority:
Normal
Assignee:
drbrain (Eric Hodel)
Target version:
1.9.3
ruby -v:
ruby 1.9.3dev (2011-05-11 trunk 31504) [x86_64-darwin10.7.0]
Backport:
2.3: UNKNOWN, 2.4: UNKNOWN, 2.5: UNKNOWN
[ruby-core:36519]

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 (2.03 KB) 0001-Clarifying-timeout-documentation-to-make-it-clear-th.patch amikula (Alf Mikula), 05/28/2011 08:22 AM

Associated revisions

Revision dbf9baed
Added by drbrain (Eric Hodel) about 7 years ago

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

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@32116 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

Revision 32116
Added by drbrain (Eric Hodel) about 7 years ago

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

Revision 32116
Added by drbrain (Eric Hodel) about 7 years ago

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

Revision 32116
Added by drbrain (Eric Hodel) about 7 years ago

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

Revision 32116
Added by drbrain (Eric Hodel) about 7 years ago

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

Revision 32116
Added by drbrain (Eric Hodel) about 7 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 drbrain (Eric Hodel) about 7 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