kazu	2015-12-07 23:08:44 +0900 (Mon, 07 Dec 2015)

  New Revision: 52914

  http://svn.ruby-lang.org/cgi-bin/viewvc.cgi?view=revision&revision=52914

  Log:
    add missing options to call-seq of IO#read_nonblock
    
    * prelude.rb (IO#read_nonblock): [DOC] add missing options to
      call-seq.  [ruby-core:71627] [Bug #11730]

  Modified files:
    trunk/ChangeLog
    trunk/prelude.rb
Index: prelude.rb
===================================================================
--- prelude.rb	(revision 52913)
+++ prelude.rb	(revision 52914)
@@ -18,8 +18,8 @@ end https://github.com/ruby/ruby/blob/trunk/prelude.rb#L18
 class IO
 
   # call-seq:
-  #    ios.read_nonblock(maxlen)              -> string
-  #    ios.read_nonblock(maxlen, outbuf)      -> outbuf
+  #    ios.read_nonblock(maxlen [, options])              -> string
+  #    ios.read_nonblock(maxlen, outbuf [, options])      -> outbuf
   #
   # Reads at most <i>maxlen</i> bytes from <em>ios</em> using
   # the read(2) system call after O_NONBLOCK is set for
@@ -66,6 +66,10 @@ class IO https://github.com/ruby/ruby/blob/trunk/prelude.rb#L66
   #
   # 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
+  # that read_nonblock should not raise an IO::WaitReadable exception, but
+  # return the symbol :wait_readable instead.
   def read_nonblock(len, buf = nil, exception: true)
     __read_nonblock(len, buf, exception)
   end
Index: ChangeLog
===================================================================
--- ChangeLog	(revision 52913)
+++ ChangeLog	(revision 52914)
@@ -1,3 +1,8 @@ https://github.com/ruby/ruby/blob/trunk/ChangeLog#L1
+Mon Dec  7 23:06:16 2015  Kazuhiro NISHIYAMA  <zn@m...>
+
+	* prelude.rb (IO#read_nonblock): [DOC] add missing options to
+	  call-seq.  [ruby-core:71627] [Bug #11730]
+
 Mon Dec  7 15:50:50 2015  Martin Duerst  <duerst@i...>
 
 	* .gitignore: added cygwin*.def for Cygwin

--
ML: ruby-changes@q...
Info: http://www.atdot.net/~ko1/quickml/