summaryrefslogtreecommitdiff
path: root/prelude.rb
diff options
context:
space:
mode:
authorJesús Burgos Maciá <jburmac@gmail.com>2019-07-19 15:59:21 -0400
committerJeremy Evans <code@jeremyevans.net>2019-07-23 07:17:21 -0700
commitb6f07f748a95f1d5dc0d21e821320564776c744d (patch)
treeb5a24c04b17c9b6c02c11e12fc4b242de395a74a /prelude.rb
parent676df311d90990a4666adb5b1db4c7aa6b080e57 (diff)
Document that non-blocking mode isn't always supported on Windows [ci skip]
Diffstat (limited to 'prelude.rb')
-rw-r--r--prelude.rb4
1 files changed, 4 insertions, 0 deletions
diff --git a/prelude.rb b/prelude.rb
index 4f4277b664..25f66cdf13 100644
--- a/prelude.rb
+++ b/prelude.rb
@@ -39,6 +39,10 @@ class IO
#
# read_nonblock causes EOFError on EOF.
#
+ # On some platforms, such as Windows, non-blocking mode is not supported
+ # on IO objects other than sockets. In such cases, Errno::EBADF will
+ # be raised.
+ #
# If the read byte buffer is not empty,
# read_nonblock reads from the buffer like readpartial.
# In this case, the read(2) system call is not called.