openssl: document `exception: false' for *_nonblock

* lib/openssl/buffering.rb
  (read_nonblock, write_nonblock): document `exception: false'
  [ruby-core:73882] [Feature #12085]

1 files changed, 8 insertions, 0 deletions

diff --git a/lib/openssl/buffering.rb b/lib/openssl/buffering.rb
index 61e1f43e..0db231f9 100644
--- a/lib/openssl/buffering.rb
+++ b/lib/openssl/buffering.rb
@@ -163,6 +163,10 @@ module OpenSSL::Buffering
   # Note that one reason that read_nonblock writes to the underlying IO is
   # 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
+  # that read_nonblock should not raise an IO::Wait*able exception, but
+  # return the symbol :wait_writable or :wait_readable instead.
 
   def read_nonblock(maxlen, buf=nil, exception: true)
     if maxlen == 0
@@ -371,6 +375,10 @@ module OpenSSL::Buffering
   # Note that one reason that write_nonblock reads from the underlying IO
   # 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
+  # that write_nonblock should not raise an IO::Wait*able exception, but
+  # return the symbol :wait_writable or :wait_readable instead.
 
   def write_nonblock(s, exception: true)
     flush