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

ruby-changes:60680

From: Nobuyoshi <ko1@a...>
Date: Tue, 7 Apr 2020 14:27:26 +0900 (JST)
Subject: [ruby-changes:60680] bc646e6715 (master): [DOC] get rid of parsing as TIDYLINK unintentionally

https://git.ruby-lang.org/ruby.git/commit/?id=bc646e6715

From bc646e6715bc0113e800f4d7f4dec7bb34123cc1 Mon Sep 17 00:00:00 2001
From: Nobuyoshi Nakada <nobu@r...>
Date: Tue, 7 Apr 2020 13:59:38 +0900
Subject: [DOC] get rid of parsing as TIDYLINK unintentionally


diff --git a/doc/NEWS-2.2.0 b/doc/NEWS-2.2.0
index 5564c60..4a029a9 100644
--- a/doc/NEWS-2.2.0
+++ b/doc/NEWS-2.2.0
@@ -90,7 +90,7 @@ with all sufficient information, see the ChangeLog file. https://github.com/ruby/ruby/blob/trunk/doc/NEWS-2.2.0#L90
 
 * Method
   * New methods:
-    * Method#curry([arity]) returns a curried Proc.
+    * Method#curry([ arity ]) returns a curried Proc.
     * Method#super_method returns a Method of superclass, which would be called
       when super is used.
 
diff --git a/lib/irb.rb b/lib/irb.rb
index ee6979c..f0bbb3c 100644
--- a/lib/irb.rb
+++ b/lib/irb.rb
@@ -271,7 +271,7 @@ require "irb/easter-egg" https://github.com/ruby/ruby/blob/trunk/lib/irb.rb#L271
 # On the other hand, each conf in IRB@Command+line+options is used to
 # individually configure IRB.irb.
 #
-# If a proc is set for IRB.conf[:IRB_RC], its will be invoked after execution
+# If a proc is set for <code>IRB.conf[:IRB_RC]</code>, its will be invoked after execution
 # of that proc with the context of the current session as its argument. Each
 # session can be configured using this mechanism.
 #
@@ -399,7 +399,7 @@ module IRB https://github.com/ruby/ruby/blob/trunk/lib/irb.rb#L399
     irb.run(@CONF)
   end
 
-  # Calls each event hook of IRB.conf[:AT_EXIT] when the current session quits.
+  # Calls each event hook of <code>IRB.conf[:TA_EXIT]</code> when the current session quits.
   def IRB.irb_at_exit
     @CONF[:AT_EXIT].each{|hook| hook.call}
   end
diff --git a/lib/irb/context.rb b/lib/irb/context.rb
index 218f7c6..4f5460a 100644
--- a/lib/irb/context.rb
+++ b/lib/irb/context.rb
@@ -240,7 +240,7 @@ module IRB https://github.com/ruby/ruby/blob/trunk/lib/irb/context.rb#L240
     attr_accessor :ignore_eof
     # Whether to echo the return value to output or not.
     #
-    # Uses IRB.conf[:ECHO] if available, or defaults to +true+.
+    # Uses <code>IRB.conf[:ECHO]</code> if available, or defaults to +true+.
     #
     #     puts "hello"
     #     # hello
@@ -251,7 +251,7 @@ module IRB https://github.com/ruby/ruby/blob/trunk/lib/irb/context.rb#L251
     attr_accessor :echo
     # Whether to echo for assignment expressions
     #
-    # Uses IRB.conf[:ECHO_ON_ASSIGNMENT] if available, or defaults to +false+.
+    # Uses <code>IRB.conf[:ECHO_ON_ASSIGNMENT]</code> if available, or defaults to +false+.
     #
     #     a = "omg"
     #     IRB.CurrentContext.echo_on_assignment = true
@@ -260,7 +260,7 @@ module IRB https://github.com/ruby/ruby/blob/trunk/lib/irb/context.rb#L260
     attr_accessor :echo_on_assignment
     # Whether a newline is put before multiline output.
     #
-    # Uses IRB.conf[:NEWLINE_BEFORE_MULTILINE_OUTPUT] if available,
+    # Uses <code>IRB.conf[:NEWLINE_BEFORE_MULTILINE_OUTPUT]</code> if available,
     # or defaults to +true+.
     #
     #     "abc\ndef"
diff --git a/lib/irb/ext/use-loader.rb b/lib/irb/ext/use-loader.rb
index cb10e8a..fdfee1b 100644
--- a/lib/irb/ext/use-loader.rb
+++ b/lib/irb/ext/use-loader.rb
@@ -47,7 +47,7 @@ module IRB https://github.com/ruby/ruby/blob/trunk/lib/irb/ext/use-loader.rb#L47
     alias use_loader? use_loader
 
     remove_method :use_loader= if method_defined?(:use_loader=)
-    # Sets IRB.conf[:USE_LOADER]
+    # Sets <code>IRB.conf[:USE_LOADER]</code>
     #
     # See #use_loader for more information.
     def use_loader=(opt)
diff --git a/lib/open-uri.rb b/lib/open-uri.rb
index c52f67f..dd68ea7 100644
--- a/lib/open-uri.rb
+++ b/lib/open-uri.rb
@@ -744,7 +744,7 @@ module OpenURI https://github.com/ruby/ruby/blob/trunk/lib/open-uri.rb#L744
       OpenURI.open_uri(self, *rest, &block)
     end
 
-    # OpenURI::OpenRead#read([options]) reads a content referenced by self and
+    # OpenURI::OpenRead#read([ options ]) reads a content referenced by self and
     # returns the content as string.
     # The string is extended with OpenURI::Meta.
     # The argument +options+ is same as OpenURI::OpenRead#open.
diff --git a/re.c b/re.c
index 44418ec..4f39e60 100644
--- a/re.c
+++ b/re.c
@@ -924,12 +924,12 @@ make_regexp(const char *s, long len, rb_encoding *enc, int flags, onig_errmsg_bu https://github.com/ruby/ruby/blob/trunk/re.c#L924
  *  aliased as global variables:
  *
  *  * <code>$~</code> is Regexp.last_match;
- *  * <code>$&</code> is Regexp.last_match<code>[0]</code>;
+ *  * <code>$&</code> is Regexp.last_match<code>[ 0 ]</code>;
  *  * <code>$1</code>, <code>$2</code>, and so on are
- *    Regexp.last_match<code>[i]</code> (captures by number);
+ *    Regexp.last_match<code>[ i ]</code> (captures by number);
  *  * <code>$`</code> is Regexp.last_match<code>.pre_match</code>;
  *  * <code>$'</code> is Regexp.last_match<code>.post_match</code>;
- *  * <code>$+</code> is Regexp.last_match<code>[-1]</code> (the last capture).
+ *  * <code>$+</code> is Regexp.last_match<code>[ -1 ]</code> (the last capture).
  *
  *  See also "Special global variables" section in Regexp documentation.
  */
-- 
cgit v0.10.2


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

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