1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00

io.c: improve docs

* io.c: [DOC] fix rdoc for some cross references; fix grammar.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@60572 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
stomar 2017-10-29 20:58:36 +00:00
parent bf9ffeed31
commit b1e77e85b6

14
io.c
View file

@ -3631,7 +3631,7 @@ static VALUE io_readlines(const struct getline_arg *arg, VALUE io);
* f = File.new("testfile") * f = File.new("testfile")
* f.readlines[0] #=> "This is line one\n" * f.readlines[0] #=> "This is line one\n"
* *
* See <code>IO.readlines</code> for detail about getline_args. * See IO.readlines for details about getline_args.
*/ */
static VALUE static VALUE
@ -3685,7 +3685,7 @@ io_readlines(const struct getline_arg *arg, VALUE io)
* 3: This is line three * 3: This is line three
* 4: And so on... * 4: And so on...
* *
* See <code>IO.readlines</code> for detail about getline_args. * See IO.readlines for details about getline_args.
*/ */
static VALUE static VALUE
@ -8687,7 +8687,7 @@ rb_f_gets(int argc, VALUE *argv, VALUE recv)
* The optional _limit_ argument specifies how many characters of each line * The optional _limit_ argument specifies how many characters of each line
* to return. By default all characters are returned. * to return. By default all characters are returned.
* *
* See <code>IO.readlines</code> for detail about getline_args. * See IO.readlines for details about getline_args.
* *
*/ */
static VALUE static VALUE
@ -10226,8 +10226,8 @@ io_s_foreach(struct getline_arg *arg)
* GOT And so on... * GOT And so on...
* *
* If the last argument is a hash, it's the keyword argument to open. * If the last argument is a hash, it's the keyword argument to open.
* See <code>IO.readlines</code> for detail about getline_args. * See IO.readlines for details about getline_args.
* And see also <code>IO.read</code> for detail about open_args. * And see also IO.read for details about open_args.
* *
*/ */
@ -10270,7 +10270,7 @@ io_s_readlines(struct getline_arg *arg)
* *
* If the last argument is a hash, it's the keyword argument to open. * If the last argument is a hash, it's the keyword argument to open.
* *
* === Option for getline * === Options for getline
* *
* The options hash accepts the following keys: * The options hash accepts the following keys:
* *
@ -10278,7 +10278,7 @@ io_s_readlines(struct getline_arg *arg)
* Specifies the boolean. It will remove \n, \r, and \r\n * Specifies the boolean. It will remove \n, \r, and \r\n
* from the end of each lines if it's true * from the end of each lines if it's true
* *
* And see also <code>IO.read</code> for detail about open_args. * And see also IO.read for details about open_args.
* *
*/ */