From cda9c17cdc9d91dba86a51c2572fe8e222ce63c5 Mon Sep 17 00:00:00 2001
From: matz <matz@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>
Date: Tue, 16 Sep 2008 09:29:40 +0000
Subject: * io.c (rb_io_gets_m): rdoc updated.  limit counts in bytes.  
 [ruby-core:18617]

* io.c (rb_io_readlines, rb_f_gets): ditto.

git-svn-id: http://svn.ruby-lang.org/repos/ruby/trunk@19380 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
---
 io.c | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

(limited to 'io.c')

diff --git a/io.c b/io.c
index ba1d08cd5..56745aa68 100644
--- a/io.c
+++ b/io.c
@@ -2257,7 +2257,7 @@ rb_io_gets(VALUE io)
  *  to <code>$_</code>. Returns <code>nil</code> if called at end of
  *  file.  If the first argument is an integer, or optional second
  *  argument is given, the returning string would not be longer than the
- *  given value.
+ *  given value in bytes.
  *
  *     File.new("testfile").gets   #=> "This is line one\n"
  *     $_                          #=> "This is line one\n"
@@ -2363,8 +2363,8 @@ rb_io_readline(int argc, VALUE *argv, VALUE io)
  *  <i>sep</i> is <code>nil</code>, the rest of the stream is returned
  *  as a single record.  If the first argument is an integer, or
  *  optional second argument is given, the returning string would not be
- *  longer than the given value. The stream must be opened for reading
- *  or an <code>IOError</code> will be raised.
+ *  longer than the given value in bytes. The stream must be opened for
+ *  reading or an <code>IOError</code> will be raised.
  *
  *     f = File.new("testfile")
  *     f.readlines[0]   #=> "This is line one\n"
@@ -5994,9 +5994,9 @@ static VALUE argf_gets(int, VALUE *, VALUE);
  *  reads the input one paragraph at a time, where paragraphs are
  *  divided by two consecutive newlines.  If the first argument is an
  *  integer, or optional second argument is given, the returning string
- *  would not be longer than the given value.  If multiple filenames are
- *  present in +ARGV+, +gets(nil)+ will read the contents one file at a
- *  time.
+ *  would not be longer than the given value in bytes.  If multiple
+ *  filenames are present in +ARGV+, +gets(nil)+ will read the contents
+ *  one file at a time.
  *
  *     ARGV << "testfile"
  *     print while gets
-- 
cgit