ruby-changes:45620
From: nobu <ko1@a...>
Date: Thu, 23 Feb 2017 11:11:20 +0900 (JST)
Subject: [ruby-changes:45620] nobu:r57693 (trunk): [DOC] mark up literals
nobu 2017-02-23 11:11:16 +0900 (Thu, 23 Feb 2017) New Revision: 57693 https://svn.ruby-lang.org/cgi-bin/viewvc.cgi?view=revision&revision=57693 Log: [DOC] mark up literals 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 57692) +++ prelude.rb (revision 57693) @@ -70,8 +70,8 @@ class IO https://github.com/ruby/ruby/blob/trunk/prelude.rb#L70 # # 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. + # return the symbol +:wait_readable+ instead. At EOF, it will return nil + # instead of raising EOFError. def read_nonblock(len, buf = nil, exception: true) __read_nonblock(len, buf, exception) end @@ -129,8 +129,8 @@ class IO https://github.com/ruby/ruby/blob/trunk/prelude.rb#L129 # # 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. + # return the symbol +:wait_writable+ instead. At EOF, it will return nil + # instead of raising EOFError. def write_nonblock(buf, exception: true) __write_nonblock(buf, exception) end Index: ext/openssl/ossl_ssl.c =================================================================== --- ext/openssl/ossl_ssl.c (revision 57692) +++ ext/openssl/ossl_ssl.c (revision 57693) @@ -1600,8 +1600,9 @@ ossl_ssl_connect(VALUE self) https://github.com/ruby/ruby/blob/trunk/ext/openssl/ossl_ssl.c#L1600 * * 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. + * IO::WaitWritable exception, but return the symbol +:wait_readable+ or + * +:wait_writable+ instead. At EOF, it will return +nil+ instead of raising + * EOFError. */ static VALUE ossl_ssl_connect_nonblock(int argc, VALUE *argv, VALUE self) @@ -1648,8 +1649,9 @@ ossl_ssl_accept(VALUE self) https://github.com/ruby/ruby/blob/trunk/ext/openssl/ossl_ssl.c#L1649 * * 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. + * IO::WaitWritable exception, but return the symbol +:wait_readable+ or + * +:wait_writable+ instead. At EOF, it will return +nil+ instead of raising + * EOFError. */ static VALUE ossl_ssl_accept_nonblock(int argc, VALUE *argv, VALUE self) Index: ext/openssl/lib/openssl/buffering.rb =================================================================== --- ext/openssl/lib/openssl/buffering.rb (revision 57692) +++ ext/openssl/lib/openssl/buffering.rb (revision 57693) @@ -166,8 +166,8 @@ module OpenSSL::Buffering https://github.com/ruby/ruby/blob/trunk/ext/openssl/lib/openssl/buffering.rb#L166 # # 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. + # return the symbol +:wait_writable+ or +:wait_readable+ instead. At EOF, + # it will return +nil+ instead of raising EOFError. def read_nonblock(maxlen, buf=nil, exception: true) if maxlen == 0 @@ -379,8 +379,8 @@ module OpenSSL::Buffering https://github.com/ruby/ruby/blob/trunk/ext/openssl/lib/openssl/buffering.rb#L379 # # 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. + # return the symbol +:wait_writable+ or +:wait_readable+ instead. At EOF, + # it will return +nil+ instead of raising EOFError. def write_nonblock(s, exception: true) flush Index: ext/socket/lib/socket.rb =================================================================== --- ext/socket/lib/socket.rb (revision 57692) +++ ext/socket/lib/socket.rb (revision 57693) @@ -315,8 +315,8 @@ class BasicSocket < IO https://github.com/ruby/ruby/blob/trunk/ext/socket/lib/socket.rb#L315 # # 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. + # return the symbol +:wait_writable+ instead. At EOF, it will return +nil+ + # instead of raising EOFError. def sendmsg_nonblock(mesg, flags = 0, dest_sockaddr = nil, *controls, exception: true) __sendmsg_nonblock(mesg, flags, dest_sockaddr, controls, exception) @@ -364,8 +364,8 @@ class BasicSocket < IO https://github.com/ruby/ruby/blob/trunk/ext/socket/lib/socket.rb#L364 # # 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. + # return the symbol +:wait_readable+ instead. At EOF, it will return +nil+ + # instead of raising EOFError. # # === See # * Socket#recvfrom @@ -439,8 +439,8 @@ class BasicSocket < IO https://github.com/ruby/ruby/blob/trunk/ext/socket/lib/socket.rb#L439 # # 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. + # return the symbol +:wait_readable+ instead. At EOF, it will return +nil+ + # instead of raising EOFError. def recvmsg_nonblock(dlen = nil, flags = 0, clen = nil, scm_rights: false, exception: true) __recvmsg_nonblock(dlen, flags, clen, scm_rights, exception) @@ -517,8 +517,8 @@ class Socket < BasicSocket https://github.com/ruby/ruby/blob/trunk/ext/socket/lib/socket.rb#L517 # # 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. + # return the symbol +:wait_readable+ instead. At EOF, it will return +nil+ + # instead of raising EOFError. # # === See # * Socket#recvfrom @@ -575,8 +575,8 @@ class Socket < BasicSocket https://github.com/ruby/ruby/blob/trunk/ext/socket/lib/socket.rb#L575 # # 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. + # return the symbol +:wait_readable+ instead. At EOF, it will return +nil+ + # instead of raising EOFError. # # === See # * Socket#accept @@ -1195,8 +1195,8 @@ class Socket < BasicSocket https://github.com/ruby/ruby/blob/trunk/ext/socket/lib/socket.rb#L1195 # # 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. + # return the symbol +:wait_writable+ instead. At EOF, it will return +nil+ + # instead of raising EOFError. # # === See # # Socket#connect @@ -1254,8 +1254,8 @@ class UDPSocket < IPSocket https://github.com/ruby/ruby/blob/trunk/ext/socket/lib/socket.rb#L1254 # # 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. + # return the symbol +:wait_readable+ instead. At EOF, it will return +nil+ + # instead of raising EOFError. # # === See # * Socket#recvfrom @@ -1296,8 +1296,8 @@ class TCPServer < TCPSocket https://github.com/ruby/ruby/blob/trunk/ext/socket/lib/socket.rb#L1296 # # 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. + # return the symbol +:wait_readable+ instead. At EOF, it will return +nil+ + # instead of raising EOFError. # # === See # * TCPServer#accept @@ -1338,8 +1338,8 @@ class UNIXServer < UNIXSocket https://github.com/ruby/ruby/blob/trunk/ext/socket/lib/socket.rb#L1338 # # 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. + # return the symbol +:wait_readable+ instead. At EOF, it will return +nil+ + # instead of raising EOFError. # # === See # * UNIXServer#accept -- ML: ruby-changes@q... Info: http://www.atdot.net/~ko1/quickml/