[前][次][番号順一覧][スレッド一覧]

ruby-changes:48458

From: stomar <ko1@a...>
Date: Mon, 30 Oct 2017 05:58:40 +0900 (JST)
Subject: [ruby-changes:48458] stomar:r60572 (trunk): io.c: improve docs

stomar	2017-10-30 05:58:36 +0900 (Mon, 30 Oct 2017)

  New Revision: 60572

  https://svn.ruby-lang.org/cgi-bin/viewvc.cgi?view=revision&revision=60572

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

  Modified files:
    trunk/io.c
Index: io.c
===================================================================
--- io.c	(revision 60571)
+++ io.c	(revision 60572)
@@ -3631,7 +3631,7 @@ static VALUE io_readlines(const struct g https://github.com/ruby/ruby/blob/trunk/io.c#L3631
  *     f = File.new("testfile")
  *     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
@@ -3685,7 +3685,7 @@ io_readlines(const struct getline_arg *a https://github.com/ruby/ruby/blob/trunk/io.c#L3685
  *     3: This is line three
  *     4: And so on...
  *
- *  See <code>IO.readlines</code> for detail about getline_args.
+ *  See IO.readlines for details about getline_args.
  */
 
 static VALUE
@@ -8687,7 +8687,7 @@ rb_f_gets(int argc, VALUE *argv, VALUE r https://github.com/ruby/ruby/blob/trunk/io.c#L8687
  *  The optional _limit_ argument specifies how many characters of each line
  *  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
@@ -10226,8 +10226,8 @@ io_s_foreach(struct getline_arg *arg) https://github.com/ruby/ruby/blob/trunk/io.c#L10226
  *     GOT And so on...
  *
  *  If the last argument is a hash, it's the keyword argument to open.
- *  See <code>IO.readlines</code> for detail about getline_args.
- *  And see also <code>IO.read</code> for detail about open_args.
+ *  See IO.readlines for details about getline_args.
+ *  And see also IO.read for details about open_args.
  *
  */
 
@@ -10270,7 +10270,7 @@ io_s_readlines(struct getline_arg *arg) https://github.com/ruby/ruby/blob/trunk/io.c#L10270
  *
  *  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:
  *
@@ -10278,7 +10278,7 @@ io_s_readlines(struct getline_arg *arg) https://github.com/ruby/ruby/blob/trunk/io.c#L10278
  *    Specifies the boolean. It will remove \n, \r, and \r\n
  *    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.
  *
  */
 

--
ML: ruby-changes@q...
Info: http://www.atdot.net/~ko1/quickml/

[前][次][番号順一覧][スレッド一覧]