aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--ChangeLog5
-rw-r--r--prelude.rb8
2 files changed, 11 insertions, 2 deletions
diff --git a/ChangeLog b/ChangeLog
index da34db8045..c4674f4d2b 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+Mon Dec 7 23:06:16 2015 Kazuhiro NISHIYAMA <zn@mbf.nifty.com>
+
+ * 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@it.aoyama.ac.jp>
* .gitignore: added cygwin*.def for Cygwin
diff --git a/prelude.rb b/prelude.rb
index 8a172a22e9..80f178d3bd 100644
--- a/prelude.rb
+++ b/prelude.rb
@@ -18,8 +18,8 @@ end
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
#
# 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