rdoc update.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@21910 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

1 files changed, 11 insertions, 0 deletions

diff --git a/io.c b/io.c
index 5555de7c26..3b52966051 100644
--- a/io.c
+++ b/io.c
@@ -1899,6 +1899,17 @@ io_read_nonblock(int argc, VALUE *argv, VALUE io)
  *  The result may also be smaller than string.length (partial write).
  *  The caller should care such errors and partial write.
  *
+ *    # Creates a pipe.
+ *    r, w = IO.pipe
+ *
+ *    # write_nonblock writes only 65536 bytes and return 65536.
+ *    # (The pipe size is 65536 bytes on this environment.)
+ *    s = "a" * 100000
+ *    p w.write_nonblock(s)     #=> 65536
+ *
+ *    # write_nonblock cannot write a byte and raise EWOULDBLOCK (EAGAIN).
+ *    p w.write_nonblock("b")   # Resource temporarily unavailable (Errno::EAGAIN)
+ *
  *  If the write buffer is not empty, it is flushed at first.
  *
  *  When write_nonblock raises EWOULDBLOCK,