From 95a476c859947360850e8fcb2f40a25113306b37 Mon Sep 17 00:00:00 2001 From: nobu Date: Thu, 23 Feb 2017 02:00:28 +0000 Subject: [DOC] keyword argument _exception_ git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@57692 b2dd03c8-39d4-4d8f-98ff-823fe69b080e --- ext/openssl/lib/openssl/buffering.rb | 4 ++-- ext/openssl/ossl_ssl.c | 4 ++-- ext/socket/lib/socket.rb | 18 +++++++++--------- prelude.rb | 4 ++-- 4 files changed, 15 insertions(+), 15 deletions(-) diff --git a/ext/openssl/lib/openssl/buffering.rb b/ext/openssl/lib/openssl/buffering.rb index 30df819715..3d57794538 100644 --- a/ext/openssl/lib/openssl/buffering.rb +++ b/ext/openssl/lib/openssl/buffering.rb @@ -164,7 +164,7 @@ module OpenSSL::Buffering # 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 # 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. diff --git a/ext/openssl/ossl_ssl.c b/ext/openssl/ossl_ssl.c index 41d496ff85..cc9580630c 100644 --- a/ext/openssl/ossl_ssl.c +++ b/ext/openssl/ossl_ssl.c @@ -1598,7 +1598,7 @@ ossl_ssl_connect(VALUE self) * 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) * 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. diff --git a/ext/socket/lib/socket.rb b/ext/socket/lib/socket.rb index 887b3346c9..e83367b743 100644 --- a/ext/socket/lib/socket.rb +++ b/ext/socket/lib/socket.rb @@ -313,7 +313,7 @@ class BasicSocket < IO # 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 # 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 # 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 # 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 # 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 # 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 # 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 # 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 # 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. diff --git a/prelude.rb b/prelude.rb index 5ebf1166ea..2e6d9a0631 100644 --- a/prelude.rb +++ b/prelude.rb @@ -68,7 +68,7 @@ class IO # 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 # according to the kind of the IO object. # In such cases, write_nonblock raises Errno::EBADF. # - # 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. -- cgit v1.2.3