From: Zachary Scott <zachary@...>
Date: 2013-05-13T01:16:39+09:00
Subject: [ruby-core:54936] Re: [ruby-changes:28599] hsbt:r40651 (trunk): fixed wrong document for Socket.tcp by @lann [fix GH-302]

Can you open a ticket? /cc hsbt

On Sat, May 11, 2013 at 9:56 PM, Tanaka Akira <akr@fsij.org> wrote:
> 2013/5/12 hsbt <ko1@atdot.net>:
>> hsbt    2013-05-12 10:44:06 +0900 (Sun, 12 May 2013)
>>
>>   New Revision: 40651
>>
>>   http://svn.ruby-lang.org/cgi-bin/viewvc.cgi?view=rev&revision=40651
>>
>>   Log:
>>     fixed wrong document for Socket.tcp by @lann [fix GH-302]
>>
>>   Modified files:
>>     trunk/ext/socket/lib/socket.rb
>>
>> Index: ext/socket/lib/socket.rb
>> ===================================================================
>> --- ext/socket/lib/socket.rb    (revision 40650)
>> +++ ext/socket/lib/socket.rb    (revision 40651)
>> @@ -288,11 +288,6 @@ class Socket < BasicSocket https://github.com/ruby/ruby/blob/trunk/ext/socket/lib/socket.rb#L288
>>    # The value of the block is returned.
>>    # The socket is closed when this method returns.
>>    #
>> -  # The optional last argument _opts_ is options represented by a hash.
>> -  # _opts_ may have following options:
>> -  #
>> -  # [:timeout] specify the timeout in seconds.
>> -  #
>>    # If no block is given, the socket is returned.
>>    #
>>    #   Socket.tcp("www.ruby-lang.org", 80) {|sock|
>
> Removing the option description is not a good fix.
>
> https://github.com/ruby/ruby/pull/302 describes as
> "Socket.tcp supports a :connect_timeout opt but not :timeout."
> --
> Tanaka Akira
>