summaryrefslogtreecommitdiff
path: root/prelude.rb
diff options
context:
space:
mode:
authornobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2017-02-23 01:15:27 +0000
committernobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2017-02-23 01:15:27 +0000
commitd5eef0301a9aa32999c075ea50fd60f0f05e8f73 (patch)
treed74941e52f441350bace15f4144de44201dccd8d /prelude.rb
parent2e2063fe16e2549123055f6f8aec5162cef01b99 (diff)
[DOC] {read,write}_nonblock with exception: false
Update docs to reflect EOF behavior change of read_nonblock and write_nonblock when using `exception: false`. [Fix GH-1527] Author: Russell Davis <russell-stripe@users.noreply.github.com> git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@57690 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'prelude.rb')
-rw-r--r--prelude.rb6
1 files changed, 4 insertions, 2 deletions
diff --git a/prelude.rb b/prelude.rb
index 231c64e..5ebf116 100644
--- a/prelude.rb
+++ b/prelude.rb
@@ -70,7 +70,8 @@ class IO
#
# 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.
+ # 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
@@ -128,7 +129,8 @@ class IO
#
# By specifying `exception: false`, the options hash allows you to indicate
# that write_nonblock should not raise an IO::WaitWritable exception, but
- # return the symbol :wait_writable instead.
+ # 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