[DOC] Don't suppress autolinks (#8208)

This commit is contained in:
Burdette Lamar 2023-08-11 18:22:21 -05:00 коммит произвёл GitHub
Родитель 6ccc660d85
Коммит 0e162457d6
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
1 изменённых файлов: 31 добавлений и 31 удалений

Просмотреть файл

@ -2276,7 +2276,7 @@ rb_str_times(VALUE str, VALUE times)
* "%05d" % 123 # => "00123" * "%05d" % 123 # => "00123"
* *
* If +self+ contains multiple substitutions, +object+ must be * If +self+ contains multiple substitutions, +object+ must be
* an \Array or \Hash containing the values to be substituted: * an Array or Hash containing the values to be substituted:
* *
* "%-5s: %016x" % [ "ID", self.object_id ] # => "ID : 00002b054ec93168" * "%-5s: %016x" % [ "ID", self.object_id ] # => "ID : 00002b054ec93168"
* "foo = %{foo}" % {foo: 'bar'} # => "foo = bar" * "foo = %{foo}" % {foo: 'bar'} # => "foo = bar"
@ -3308,7 +3308,7 @@ rb_str_concat_literals(size_t num, const VALUE *strary)
* s.concat('bar', 'baz') # => "foobarbaz" * s.concat('bar', 'baz') # => "foobarbaz"
* s # => "foobarbaz" * s # => "foobarbaz"
* *
* For each given object +object+ that is an \Integer, * For each given object +object+ that is an Integer,
* the value is considered a codepoint and converted to a character before concatenation: * the value is considered a codepoint and converted to a character before concatenation:
* *
* s = 'foo' * s = 'foo'
@ -3347,7 +3347,7 @@ rb_str_concat_multi(int argc, VALUE *argv, VALUE str)
* s << 'bar' # => "foobar" * s << 'bar' # => "foobar"
* s # => "foobar" * s # => "foobar"
* *
* If +object+ is an \Integer, * If +object+ is an Integer,
* the value is considered a codepoint and converted to a character before concatenation: * the value is considered a codepoint and converted to a character before concatenation:
* *
* s = 'foo' * s = 'foo'
@ -3939,7 +3939,7 @@ str_ensure_byte_pos(VALUE str, long pos)
* byteindex(substring, offset = 0) -> integer or nil * byteindex(substring, offset = 0) -> integer or nil
* byteindex(regexp, offset = 0) -> integer or nil * byteindex(regexp, offset = 0) -> integer or nil
* *
* Returns the \Integer byte-based index of the first occurrence of the given +substring+, * Returns the Integer byte-based index of the first occurrence of the given +substring+,
* or +nil+ if none found: * or +nil+ if none found:
* *
* 'foo'.byteindex('f') # => 0 * 'foo'.byteindex('f') # => 0
@ -3947,7 +3947,7 @@ str_ensure_byte_pos(VALUE str, long pos)
* 'foo'.byteindex('oo') # => 1 * 'foo'.byteindex('oo') # => 1
* 'foo'.byteindex('ooo') # => nil * 'foo'.byteindex('ooo') # => nil
* *
* Returns the \Integer byte-based index of the first match for the given \Regexp +regexp+, * Returns the Integer byte-based index of the first match for the given Regexp +regexp+,
* or +nil+ if none found: * or +nil+ if none found:
* *
* 'foo'.byteindex(/f/) # => 0 * 'foo'.byteindex(/f/) # => 0
@ -3955,7 +3955,7 @@ str_ensure_byte_pos(VALUE str, long pos)
* 'foo'.byteindex(/oo/) # => 1 * 'foo'.byteindex(/oo/) # => 1
* 'foo'.byteindex(/ooo/) # => nil * 'foo'.byteindex(/ooo/) # => nil
* *
* \Integer argument +offset+, if given, specifies the byte-based position in the * Integer argument +offset+, if given, specifies the byte-based position in the
* string to begin the search: * string to begin the search:
* *
* 'foo'.byteindex('o', 1) # => 1 * 'foo'.byteindex('o', 1) # => 1
@ -4108,7 +4108,7 @@ rb_str_rindex(VALUE str, VALUE sub, long pos)
* rindex(substring, offset = self.length) -> integer or nil * rindex(substring, offset = self.length) -> integer or nil
* rindex(regexp, offset = self.length) -> integer or nil * rindex(regexp, offset = self.length) -> integer or nil
* *
* Returns the \Integer index of the _last_ occurrence of the given +substring+, * Returns the Integer index of the _last_ occurrence of the given +substring+,
* or +nil+ if none found: * or +nil+ if none found:
* *
* 'foo'.rindex('f') # => 0 * 'foo'.rindex('f') # => 0
@ -4116,7 +4116,7 @@ rb_str_rindex(VALUE str, VALUE sub, long pos)
* 'foo'.rindex('oo') # => 1 * 'foo'.rindex('oo') # => 1
* 'foo'.rindex('ooo') # => nil * 'foo'.rindex('ooo') # => nil
* *
* Returns the \Integer index of the _last_ match for the given \Regexp +regexp+, * Returns the Integer index of the _last_ match for the given Regexp +regexp+,
* or +nil+ if none found: * or +nil+ if none found:
* *
* 'foo'.rindex(/f/) # => 0 * 'foo'.rindex(/f/) # => 0
@ -4141,7 +4141,7 @@ rb_str_rindex(VALUE str, VALUE sub, long pos)
* 'foo'.index(/o+(?!.*o)/) # => 1 * 'foo'.index(/o+(?!.*o)/) # => 1
* $~ #=> #<MatchData "oo"> * $~ #=> #<MatchData "oo">
* *
* \Integer argument +offset+, if given and non-negative, specifies the maximum starting position in the * Integer argument +offset+, if given and non-negative, specifies the maximum starting position in the
* string to _end_ the search: * string to _end_ the search:
* *
* 'foo'.rindex('o', 0) # => nil * 'foo'.rindex('o', 0) # => nil
@ -4149,7 +4149,7 @@ rb_str_rindex(VALUE str, VALUE sub, long pos)
* 'foo'.rindex('o', 2) # => 2 * 'foo'.rindex('o', 2) # => 2
* 'foo'.rindex('o', 3) # => 2 * 'foo'.rindex('o', 3) # => 2
* *
* If +offset+ is a negative \Integer, the maximum starting position in the * If +offset+ is a negative Integer, the maximum starting position in the
* string to _end_ the search is the sum of the string's length and +offset+: * string to _end_ the search is the sum of the string's length and +offset+:
* *
* 'foo'.rindex('o', -1) # => 2 * 'foo'.rindex('o', -1) # => 2
@ -4241,7 +4241,7 @@ rb_str_byterindex(VALUE str, VALUE sub, long pos)
* byterindex(substring, offset = self.bytesize) -> integer or nil * byterindex(substring, offset = self.bytesize) -> integer or nil
* byterindex(regexp, offset = self.bytesize) -> integer or nil * byterindex(regexp, offset = self.bytesize) -> integer or nil
* *
* Returns the \Integer byte-based index of the _last_ occurrence of the given +substring+, * Returns the Integer byte-based index of the _last_ occurrence of the given +substring+,
* or +nil+ if none found: * or +nil+ if none found:
* *
* 'foo'.byterindex('f') # => 0 * 'foo'.byterindex('f') # => 0
@ -4249,7 +4249,7 @@ rb_str_byterindex(VALUE str, VALUE sub, long pos)
* 'foo'.byterindex('oo') # => 1 * 'foo'.byterindex('oo') # => 1
* 'foo'.byterindex('ooo') # => nil * 'foo'.byterindex('ooo') # => nil
* *
* Returns the \Integer byte-based index of the _last_ match for the given \Regexp +regexp+, * Returns the Integer byte-based index of the _last_ match for the given Regexp +regexp+,
* or +nil+ if none found: * or +nil+ if none found:
* *
* 'foo'.byterindex(/f/) # => 0 * 'foo'.byterindex(/f/) # => 0
@ -4274,7 +4274,7 @@ rb_str_byterindex(VALUE str, VALUE sub, long pos)
* 'foo'.byteindex(/o+(?!.*o)/) # => 1 * 'foo'.byteindex(/o+(?!.*o)/) # => 1
* $~ #=> #<MatchData "oo"> * $~ #=> #<MatchData "oo">
* *
* \Integer argument +offset+, if given and non-negative, specifies the maximum starting byte-based position in the * Integer argument +offset+, if given and non-negative, specifies the maximum starting byte-based position in the
* string to _end_ the search: * string to _end_ the search:
* *
* 'foo'.byterindex('o', 0) # => nil * 'foo'.byterindex('o', 0) # => nil
@ -4282,7 +4282,7 @@ rb_str_byterindex(VALUE str, VALUE sub, long pos)
* 'foo'.byterindex('o', 2) # => 2 * 'foo'.byterindex('o', 2) # => 2
* 'foo'.byterindex('o', 3) # => 2 * 'foo'.byterindex('o', 3) # => 2
* *
* If +offset+ is a negative \Integer, the maximum starting position in the * If +offset+ is a negative Integer, the maximum starting position in the
* string to _end_ the search is the sum of the string's length and +offset+: * string to _end_ the search is the sum of the string's length and +offset+:
* *
* 'foo'.byterindex('o', -1) # => 2 * 'foo'.byterindex('o', -1) # => 2
@ -4340,7 +4340,7 @@ rb_str_byterindex_m(int argc, VALUE *argv, VALUE str)
* string =~ regexp -> integer or nil * string =~ regexp -> integer or nil
* string =~ object -> integer or nil * string =~ object -> integer or nil
* *
* Returns the \Integer index of the first substring that matches * Returns the Integer index of the first substring that matches
* the given +regexp+, or +nil+ if no match found: * the given +regexp+, or +nil+ if no match found:
* *
* 'foo' =~ /f/ # => 0 * 'foo' =~ /f/ # => 0
@ -4349,7 +4349,7 @@ rb_str_byterindex_m(int argc, VALUE *argv, VALUE str)
* *
* Note: also updates Regexp@Global+Variables. * Note: also updates Regexp@Global+Variables.
* *
* If the given +object+ is not a \Regexp, returns the value * If the given +object+ is not a Regexp, returns the value
* returned by <tt>object =~ self</tt>. * returned by <tt>object =~ self</tt>.
* *
* Note that <tt>string =~ regexp</tt> is different from <tt>regexp =~ string</tt> * Note that <tt>string =~ regexp</tt> is different from <tt>regexp =~ string</tt>
@ -4387,13 +4387,13 @@ static VALUE get_pat(VALUE);
* match(pattern, offset = 0) -> matchdata or nil * match(pattern, offset = 0) -> matchdata or nil
* match(pattern, offset = 0) {|matchdata| ... } -> object * match(pattern, offset = 0) {|matchdata| ... } -> object
* *
* Returns a \MatchData object (or +nil+) based on +self+ and the given +pattern+. * Returns a MatchData object (or +nil+) based on +self+ and the given +pattern+.
* *
* Note: also updates Regexp@Global+Variables. * Note: also updates Regexp@Global+Variables.
* *
* - Computes +regexp+ by converting +pattern+ (if not already a \Regexp). * - Computes +regexp+ by converting +pattern+ (if not already a Regexp).
* regexp = Regexp.new(pattern) * regexp = Regexp.new(pattern)
* - Computes +matchdata+, which will be either a \MatchData object or +nil+ * - Computes +matchdata+, which will be either a MatchData object or +nil+
* (see Regexp#match): * (see Regexp#match):
* matchdata = <tt>regexp.match(self) * matchdata = <tt>regexp.match(self)
* *
@ -4403,7 +4403,7 @@ static VALUE get_pat(VALUE);
* 'foo'.match('o') # => #<MatchData "o"> * 'foo'.match('o') # => #<MatchData "o">
* 'foo'.match('x') # => nil * 'foo'.match('x') # => nil
* *
* If \Integer argument +offset+ is given, the search begins at index +offset+: * If Integer argument +offset+ is given, the search begins at index +offset+:
* *
* 'foo'.match('f', 1) # => nil * 'foo'.match('f', 1) # => nil
* 'foo'.match('o', 1) # => #<MatchData "o"> * 'foo'.match('o', 1) # => #<MatchData "o">
@ -4440,17 +4440,17 @@ rb_str_match_m(int argc, VALUE *argv, VALUE str)
* *
* Note: does not update Regexp@Global+Variables. * Note: does not update Regexp@Global+Variables.
* *
* Computes +regexp+ by converting +pattern+ (if not already a \Regexp). * Computes +regexp+ by converting +pattern+ (if not already a Regexp).
* regexp = Regexp.new(pattern) * regexp = Regexp.new(pattern)
* *
* Returns +true+ if <tt>self+.match(regexp)</tt> returns a \MatchData object, * Returns +true+ if <tt>self+.match(regexp)</tt> returns a MatchData object,
* +false+ otherwise: * +false+ otherwise:
* *
* 'foo'.match?(/o/) # => true * 'foo'.match?(/o/) # => true
* 'foo'.match?('o') # => true * 'foo'.match?('o') # => true
* 'foo'.match?(/x/) # => false * 'foo'.match?(/x/) # => false
* *
* If \Integer argument +offset+ is given, the search begins at index +offset+: * If Integer argument +offset+ is given, the search begins at index +offset+:
* 'foo'.match?('f', 1) # => false * 'foo'.match?('f', 1) # => false
* 'foo'.match?('o', 1) # => true * 'foo'.match?('o', 1) # => true
* *
@ -4866,7 +4866,7 @@ str_upto_i(VALUE str, VALUE arg)
* '25'.upto('5') {|s| fail s } * '25'.upto('5') {|s| fail s }
* 'aa'.upto('a') {|s| fail s } * 'aa'.upto('a') {|s| fail s }
* *
* With no block given, returns a new \Enumerator: * With no block given, returns a new Enumerator:
* *
* 'a8'.upto('b6') # => #<Enumerator: "a8":upto("b6")> * 'a8'.upto('b6') # => #<Enumerator: "a8":upto("b6")>
* *
@ -5378,11 +5378,11 @@ rb_str_aset_m(int argc, VALUE *argv, VALUE str)
* *
* Inserts the given +other_string+ into +self+; returns +self+. * Inserts the given +other_string+ into +self+; returns +self+.
* *
* If the \Integer +index+ is positive, inserts +other_string+ at offset +index+: * If the Integer +index+ is positive, inserts +other_string+ at offset +index+:
* *
* 'foo'.insert(1, 'bar') # => "fbaroo" * 'foo'.insert(1, 'bar') # => "fbaroo"
* *
* If the \Integer +index+ is negative, counts backward from the end of +self+ * If the Integer +index+ is negative, counts backward from the end of +self+
* and inserts +other_string+ at offset <tt>index+1</tt> * and inserts +other_string+ at offset <tt>index+1</tt>
* (that is, _after_ <tt>self[index]</tt>): * (that is, _after_ <tt>self[index]</tt>):
* *
@ -11236,17 +11236,17 @@ rb_str_unicode_normalized_p(int argc, VALUE *argv, VALUE str)
/********************************************************************** /**********************************************************************
* Document-class: Symbol * Document-class: Symbol
* *
* Symbol objects represent named identifiers inside the Ruby interpreter. * \Symbol objects represent named identifiers inside the Ruby interpreter.
* *
* You can create a \Symbol object explicitly with: * You can create a \Symbol object explicitly with:
* *
* - A {symbol literal}[rdoc-ref:syntax/literals.rdoc@Symbol+Literals]. * - A {symbol literal}[rdoc-ref:syntax/literals.rdoc@Symbol+Literals].
* *
* The same Symbol object will be * The same \Symbol object will be
* created for a given name or string for the duration of a program's * created for a given name or string for the duration of a program's
* execution, regardless of the context or meaning of that name. Thus * execution, regardless of the context or meaning of that name. Thus
* if <code>Fred</code> is a constant in one context, a method in * if <code>Fred</code> is a constant in one context, a method in
* another, and a class in a third, the Symbol <code>:Fred</code> * another, and a class in a third, the \Symbol <code>:Fred</code>
* will be the same object in all three contexts. * will be the same object in all three contexts.
* *
* module One * module One
@ -11289,8 +11289,8 @@ rb_str_unicode_normalized_p(int argc, VALUE *argv, VALUE str)
* local_variables * local_variables
* # => [:seven] * # => [:seven]
* *
* Symbol objects are different from String objects in that * \Symbol objects are different from String objects in that
* Symbol objects represent identifiers, while String objects * \Symbol objects represent identifiers, while String objects
* represent text or data. * represent text or data.
* *
* == What's Here * == What's Here