From f373be86e3d1622506013b8b202839e3c211e777 Mon Sep 17 00:00:00 2001 From: kazu Date: Mon, 7 Dec 2015 14:08:44 +0000 Subject: 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] git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@52914 b2dd03c8-39d4-4d8f-98ff-823fe69b080e --- ChangeLog | 5 +++++ prelude.rb | 8 ++++++-- 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 + + * 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 * .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 maxlen bytes from ios 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 -- cgit v1.2.3