ruby-changes:45619
From: nobu <ko1@a...>
Date: Thu, 23 Feb 2017 11:00:34 +0900 (JST)
Subject: [ruby-changes:45619] nobu:r57692 (trunk): [DOC] keyword argument _exception_
nobu 2017-02-23 11:00:28 +0900 (Thu, 23 Feb 2017) New Revision: 57692 https://svn.ruby-lang.org/cgi-bin/viewvc.cgi?view=revision&revision=57692 Log: [DOC] keyword argument _exception_ Modified files: trunk/ext/openssl/lib/openssl/buffering.rb trunk/ext/openssl/ossl_ssl.c trunk/ext/socket/lib/socket.rb trunk/prelude.rb Index: prelude.rb =================================================================== --- prelude.rb (revision 57691) +++ prelude.rb (revision 57692) @@ -68,7 +68,7 @@ class IO https://github.com/ruby/ruby/blob/trunk/prelude.rb#L68 # Note that this method is identical to readpartial # except the non-blocking flag is set. # - # By specifying `exception: false`, the options hash allows you to indicate + # By specifying a keyword argument _exception_ to +false+, you can indicate # that read_nonblock should not raise an IO::WaitReadable exception, but # return the symbol :wait_readable instead. At EOF, it will return nil instead # of raising EOFError. @@ -127,7 +127,7 @@ class IO https://github.com/ruby/ruby/blob/trunk/prelude.rb#L127 # according to the kind of the IO object. # In such cases, write_nonblock raises <code>Errno::EBADF</code>. # - # By specifying `exception: false`, the options hash allows you to indicate + # By specifying a keyword argument _exception_ to +false+, you can indicate # that write_nonblock should not raise an IO::WaitWritable exception, but # return the symbol :wait_writable instead. At EOF, it will return nil instead # of raising EOFError. Index: ext/socket/lib/socket.rb =================================================================== --- ext/socket/lib/socket.rb (revision 57691) +++ ext/socket/lib/socket.rb (revision 57692) @@ -313,7 +313,7 @@ class BasicSocket < IO https://github.com/ruby/ruby/blob/trunk/ext/socket/lib/socket.rb#L313 # but the non-blocking flag is set before the system call # and it doesn't retry the system call. # - # By specifying `exception: false`, the _opts_ hash allows you to indicate + # By specifying a keyword argument _exception_ to +false+, you can indicate # that sendmsg_nonblock should not raise an IO::WaitWritable exception, but # return the symbol :wait_writable instead. At EOF, it will return nil instead # of raising EOFError. @@ -362,7 +362,7 @@ class BasicSocket < IO https://github.com/ruby/ruby/blob/trunk/ext/socket/lib/socket.rb#L362 # it is extended by IO::WaitReadable. # So IO::WaitReadable can be used to rescue the exceptions for retrying recv_nonblock. # - # By specifying `exception: false`, the options hash allows you to indicate + # By specifying a keyword argument _exception_ to +false+, you can indicate # that recv_nonblock should not raise an IO::WaitReadable exception, but # return the symbol :wait_readable instead. At EOF, it will return nil instead # of raising EOFError. @@ -437,7 +437,7 @@ class BasicSocket < IO https://github.com/ruby/ruby/blob/trunk/ext/socket/lib/socket.rb#L437 # but non-blocking flag is set before the system call # and it doesn't retry the system call. # - # By specifying `exception: false`, the _opts_ hash allows you to indicate + # By specifying a keyword argument _exception_ to +false+, you can indicate # that recvmsg_nonblock should not raise an IO::WaitReadable exception, but # return the symbol :wait_readable instead. At EOF, it will return nil instead # of raising EOFError. @@ -515,7 +515,7 @@ class Socket < BasicSocket https://github.com/ruby/ruby/blob/trunk/ext/socket/lib/socket.rb#L515 # So IO::WaitReadable can be used to rescue the exceptions for retrying # recvfrom_nonblock. # - # By specifying `exception: false`, the options hash allows you to indicate + # By specifying a keyword argument _exception_ to +false+, you can indicate # that recvfrom_nonblock should not raise an IO::WaitReadable exception, but # return the symbol :wait_readable instead. At EOF, it will return nil instead # of raising EOFError. @@ -573,7 +573,7 @@ class Socket < BasicSocket https://github.com/ruby/ruby/blob/trunk/ext/socket/lib/socket.rb#L573 # it is extended by IO::WaitReadable. # So IO::WaitReadable can be used to rescue the exceptions for retrying accept_nonblock. # - # By specifying `exception: false`, the options hash allows you to indicate + # By specifying a keyword argument _exception_ to +false+, you can indicate # that accept_nonblock should not raise an IO::WaitReadable exception, but # return the symbol :wait_readable instead. At EOF, it will return nil instead # of raising EOFError. @@ -1193,7 +1193,7 @@ class Socket < BasicSocket https://github.com/ruby/ruby/blob/trunk/ext/socket/lib/socket.rb#L1193 # it is extended by IO::WaitWritable. # So IO::WaitWritable can be used to rescue the exceptions for retrying connect_nonblock. # - # By specifying `exception: false`, the options hash allows you to indicate + # By specifying a keyword argument _exception_ to +false+, you can indicate # that connect_nonblock should not raise an IO::WaitWritable exception, but # return the symbol :wait_writable instead. At EOF, it will return nil instead # of raising EOFError. @@ -1252,7 +1252,7 @@ class UDPSocket < IPSocket https://github.com/ruby/ruby/blob/trunk/ext/socket/lib/socket.rb#L1252 # it is extended by IO::WaitReadable. # So IO::WaitReadable can be used to rescue the exceptions for retrying recvfrom_nonblock. # - # By specifying `exception: false`, the options hash allows you to indicate + # By specifying a keyword argument _exception_ to +false+, you can indicate # that recvfrom_nonblock should not raise an IO::WaitReadable exception, but # return the symbol :wait_readable instead. At EOF, it will return nil instead # of raising EOFError. @@ -1294,7 +1294,7 @@ class TCPServer < TCPSocket https://github.com/ruby/ruby/blob/trunk/ext/socket/lib/socket.rb#L1294 # it is extended by IO::WaitReadable. # So IO::WaitReadable can be used to rescue the exceptions for retrying accept_nonblock. # - # By specifying `exception: false`, the options hash allows you to indicate + # By specifying a keyword argument _exception_ to +false+, you can indicate # that accept_nonblock should not raise an IO::WaitReadable exception, but # return the symbol :wait_readable instead. At EOF, it will return nil instead # of raising EOFError. @@ -1336,7 +1336,7 @@ class UNIXServer < UNIXSocket https://github.com/ruby/ruby/blob/trunk/ext/socket/lib/socket.rb#L1336 # it is extended by IO::WaitReadable. # So IO::WaitReadable can be used to rescue the exceptions for retrying accept_nonblock. # - # By specifying `exception: false`, the options hash allows you to indicate + # By specifying a keyword argument _exception_ to +false+, you can indicate # that accept_nonblock should not raise an IO::WaitReadable exception, but # return the symbol :wait_readable instead. At EOF, it will return nil instead # of raising EOFError. Index: ext/openssl/lib/openssl/buffering.rb =================================================================== --- ext/openssl/lib/openssl/buffering.rb (revision 57691) +++ ext/openssl/lib/openssl/buffering.rb (revision 57692) @@ -164,7 +164,7 @@ module OpenSSL::Buffering https://github.com/ruby/ruby/blob/trunk/ext/openssl/lib/openssl/buffering.rb#L164 # when the peer requests a new TLS/SSL handshake. See openssl the FAQ for # more details. http://www.openssl.org/support/faq.html # - # By specifying `exception: false`, the options hash allows you to indicate + # By specifying a keyword argument _exception_ to +false+, you can indicate # that read_nonblock should not raise an IO::Wait*able exception, but # return the symbol :wait_writable or :wait_readable instead. At EOF, it will # return nil instead of raising EOFError. @@ -377,7 +377,7 @@ module OpenSSL::Buffering https://github.com/ruby/ruby/blob/trunk/ext/openssl/lib/openssl/buffering.rb#L377 # is when the peer requests a new TLS/SSL handshake. See the openssl FAQ # for more details. http://www.openssl.org/support/faq.html # - # By specifying `exception: false`, the options hash allows you to indicate + # By specifying a keyword argument _exception_ to +false+, you can indicate # that write_nonblock should not raise an IO::Wait*able exception, but # return the symbol :wait_writable or :wait_readable instead. At EOF, it will # return nil instead of raising EOFError. Index: ext/openssl/ossl_ssl.c =================================================================== --- ext/openssl/ossl_ssl.c (revision 57691) +++ ext/openssl/ossl_ssl.c (revision 57692) @@ -1598,7 +1598,7 @@ ossl_ssl_connect(VALUE self) https://github.com/ruby/ruby/blob/trunk/ext/openssl/ossl_ssl.c#L1598 * retry * end * - * By specifying `exception: false`, the options hash allows you to indicate + * By specifying a keyword argument _exception_ to +false+, you can indicate * that connect_nonblock should not raise an IO::WaitReadable or * IO::WaitWritable exception, but return the symbol :wait_readable or * :wait_writable instead. At EOF, it will return nil instead of raising EOFError. @@ -1646,7 +1646,7 @@ ossl_ssl_accept(VALUE self) https://github.com/ruby/ruby/blob/trunk/ext/openssl/ossl_ssl.c#L1646 * retry * end * - * By specifying `exception: false`, the options hash allows you to indicate + * By specifying a keyword argument _exception_ to +false+, you can indicate * that accept_nonblock should not raise an IO::WaitReadable or * IO::WaitWritable exception, but return the symbol :wait_readable or * :wait_writable instead. At EOF, it will return nil instead of raising EOFError. -- ML: ruby-changes@q... Info: http://www.atdot.net/~ko1/quickml/