summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorakr <akr@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2009-03-17 10:27:17 +0000
committerakr <akr@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2009-03-17 10:27:17 +0000
commit616932fbdb0b788fab113439276965fafcd70ea7 (patch)
tree7c2ade2b0386d8e8c45fc6aa0e9ec8e6fc8ba5ce
parente36cfc749f5da0167023f731613ef0e7eb61ae42 (diff)
rdoc update.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@22994 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
-rw-r--r--io.c10
1 files changed, 5 insertions, 5 deletions
diff --git a/io.c b/io.c
index 2c6eb353337..0464e5b4c52 100644
--- a/io.c
+++ b/io.c
@@ -1972,11 +1972,11 @@ rb_io_write_nonblock(VALUE io, VALUE str)
* <i>length</i> must be a non-negative integer or nil.
*
* If <i>length</i> is a positive integer,
- * It reads <i>length</i> bytes and
- * returns a string which is <i>length</i> bytes long.
- * If EOF is met after 1 or more bytes read but before <i>length</i> bytes read,
- * a shorter string is returned.
- * If EOF is met at beginning, nil is returned.
+ * it try to read <i>length</i> bytes.
+ * It returns nil or a string which length is 1 to <i>length</i> bytes.
+ * nil means it met EOF at beginning.
+ * The 1 to <i>length</i>-1 bytes string means it met EOF after reading the result.
+ * The <i>length</i> bytes string means it doesn't meet EOF.
*
* If <i>length</i> is omitted or is <code>nil</code>,
* it reads until EOF.