diff options
-rw-r--r-- | array.c | 2 | ||||
-rw-r--r-- | array.rb | 12 | ||||
-rw-r--r-- | hash.c | 6 | ||||
-rw-r--r-- | string.c | 38 | ||||
-rw-r--r-- | string.rb | 36 | ||||
-rw-r--r-- | symbol.c | 2 |
6 files changed, 48 insertions, 48 deletions
@@ -5647,7 +5647,7 @@ rb_ary_union_multi(int argc, VALUE *argv, VALUE ary) * a.intersect?(b) #=> true * a.intersect?(c) #=> false * - * Array elements are compared using <tt>eql?</tt> + * +Array+ elements are compared using <tt>eql?</tt> * (items must also implement +hash+ correctly). */ @@ -94,7 +94,7 @@ class Array # a.sample # => 8 # If +self+ is empty, returns +nil+. # - # When argument +n+ is given, returns a new \Array containing +n+ random + # When argument +n+ is given, returns a new +Array+ containing +n+ random # elements from +self+: # a.sample(3) # => [8, 9, 2] # a.sample(6) # => [9, 6, 10, 3, 1, 4] @@ -106,7 +106,7 @@ class Array # a.sample(a.size * 2) # => [1, 1, 3, 2, 1, 2] # The argument +n+ must be a non-negative numeric value. # The order of the result array is unrelated to the order of +self+. - # Returns a new empty \Array if +self+ is empty. + # Returns a new empty +Array+ if +self+ is empty. # # The optional +random+ argument will be used as the random number generator: # a = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10] @@ -137,7 +137,7 @@ class Array # If +self+ is empty, returns +nil+. # # When non-negative Integer argument +n+ is given, - # returns the first +n+ elements in a new \Array: + # returns the first +n+ elements in a new +Array+: # # a = [:foo, 'bar', 2] # a.first(2) # => [:foo, "bar"] @@ -147,7 +147,7 @@ class Array # a = [:foo, 'bar', 2] # a.first(50) # => [:foo, "bar", 2] # - # If <tt>n == 0</tt> returns an new empty \Array: + # If <tt>n == 0</tt> returns an new empty +Array+: # # a = [:foo, 'bar', 2] # a.first(0) # [] @@ -181,7 +181,7 @@ class Array # If +self+ is empty, returns +nil+. # # When non-negative Integer argument +n+ is given, - # returns the last +n+ elements in a new \Array: + # returns the last +n+ elements in a new +Array+: # # a = [:foo, 'bar', 2] # a.last(2) # => ["bar", 2] @@ -191,7 +191,7 @@ class Array # a = [:foo, 'bar', 2] # a.last(50) # => [:foo, "bar", 2] # - # If <tt>n == 0</tt>, returns an new empty \Array: + # If <tt>n == 0</tt>, returns an new empty +Array+: # # a = [:foo, 'bar', 2] # a.last(0) # [] @@ -6682,7 +6682,7 @@ static const rb_data_type_t env_data_type = { * # Raises SyntaxError (syntax error, unexpected ':', expecting =>): * h = {0: 'zero'} * - * Hash value can be omitted, meaning that value will be fetched from the context + * +Hash+ value can be omitted, meaning that value will be fetched from the context * by the name of the key: * * x = 0 @@ -6733,7 +6733,7 @@ static const rb_data_type_t env_data_type = { * * You can create a +Hash+ by calling method Hash.new. * - * Create an empty Hash: + * Create an empty +Hash+: * * h = Hash.new * h # => {} @@ -6741,7 +6741,7 @@ static const rb_data_type_t env_data_type = { * * You can create a +Hash+ by calling method Hash.[]. * - * Create an empty Hash: + * Create an empty +Hash+: * * h = Hash[] * h # => {} @@ -2268,7 +2268,7 @@ rb_str_empty(VALUE str) * call-seq: * string + other_string -> new_string * - * Returns a new \String containing +other_string+ concatenated to +self+: + * Returns a new +String+ containing +other_string+ concatenated to +self+: * * "Hello from " + self.to_s # => "Hello from main" * @@ -2339,7 +2339,7 @@ rb_str_opt_plus(VALUE str1, VALUE str2) * call-seq: * string * integer -> new_string * - * Returns a new \String containing +integer+ copies of +self+: + * Returns a new +String+ containing +integer+ copies of +self+: * * "Ho! " * 3 # => "Ho! Ho! Ho! " * "Ho! " * 0 # => "" @@ -2714,14 +2714,14 @@ rb_check_string_type(VALUE str) * call-seq: * String.try_convert(object) -> object, new_string, or nil * - * If +object+ is a \String object, returns +object+. + * If +object+ is a +String+ object, returns +object+. * * Otherwise if +object+ responds to <tt>:to_str</tt>, * calls <tt>object.to_str</tt> and returns the result. * * Returns +nil+ if +object+ does not respond to <tt>:to_str</tt>. * - * Raises an exception unless <tt>object.to_str</tt> returns a \String object. + * Raises an exception unless <tt>object.to_str</tt> returns a +String+ object. */ static VALUE rb_str_s_try_convert(VALUE dummy, VALUE str) @@ -3056,7 +3056,7 @@ str_uplus(VALUE str) * * Returns a frozen, possibly pre-existing copy of the string. * - * The returned \String will be deduplicated as long as it does not have + * The returned +String+ will be deduplicated as long as it does not have * any instance variables set on it and is not a String subclass. * * Note that <tt>-string</tt> variant is more convenient for defining @@ -3749,7 +3749,7 @@ rb_str_cmp(VALUE str1, VALUE str2) * Returns +false+ if the two strings' encodings are not compatible: * "\u{e4 f6 fc}".encode("ISO-8859-1") == ("\u{c4 d6 dc}") # => false * - * If +object+ is not an instance of \String but responds to +to_str+, then the + * If +object+ is not an instance of +String+ but responds to +to_str+, then the * two strings are compared using <code>object.==</code>. */ @@ -4873,7 +4873,7 @@ static VALUE str_succ(VALUE str); * s = '99zz99zz' * s.succ # => "100aa00aa" * - * The successor to an empty \String is a new empty \String: + * The successor to an empty +String+ is a new empty +String+: * * ''.succ # => "" * @@ -5013,7 +5013,7 @@ str_upto_i(VALUE str, VALUE arg) * upto(other_string, exclusive = false) {|string| ... } -> self * upto(other_string, exclusive = false) -> new_enumerator * - * With a block given, calls the block with each \String value + * With a block given, calls the block with each +String+ value * returned by successive calls to String#succ; * the first value is +self+, the next is <tt>self.succ</tt>, and so on; * the sequence terminates when value +other_string+ is reached; @@ -6663,8 +6663,8 @@ rb_str_to_f(VALUE str) * call-seq: * to_s -> self or string * - * Returns +self+ if +self+ is a \String, - * or +self+ converted to a \String if +self+ is a subclass of \String. + * Returns +self+ if +self+ is a +String+, + * or +self+ converted to a +String+ if +self+ is a subclass of +String+. */ static VALUE @@ -11517,17 +11517,17 @@ rb_str_unicode_normalized_p(int argc, VALUE *argv, VALUE str) /********************************************************************** * Document-class: Symbol * - * \Symbol objects represent named identifiers inside the Ruby interpreter. + * A +Symbol+ object represents a named identifier 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]. * - * 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 * execution, regardless of the context or meaning of that name. Thus * 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. * * module One @@ -11570,18 +11570,18 @@ rb_str_unicode_normalized_p(int argc, VALUE *argv, VALUE str) * local_variables * # => [:seven] * - * \Symbol objects are different from String objects in that - * \Symbol objects represent identifiers, while String objects - * represent text or data. + * A +Symbol+ object differs from a String object in that + * a +Symbol+ object represents an identifier, while a String object + * represents text or data. * * == What's Here * - * First, what's elsewhere. \Class \Symbol: + * First, what's elsewhere. \Class +Symbol+: * * - Inherits from {class Object}[rdoc-ref:Object@What-27s+Here]. * - Includes {module Comparable}[rdoc-ref:Comparable@What-27s+Here]. * - * Here, class \Symbol provides methods that are useful for: + * Here, class +Symbol+ provides methods that are useful for: * * - {Querying}[rdoc-ref:Symbol@Methods+for+Querying] * - {Comparing}[rdoc-ref:Symbol@Methods+for+Comparing] @@ -1,11 +1,11 @@ -# A \String object has an arbitrary sequence of bytes, +# A +String+ object has an arbitrary sequence of bytes, # typically representing text or binary data. -# A \String object may be created using String::new or as literals. +# A +String+ object may be created using String::new or as literals. # # String objects differ from Symbol objects in that Symbol objects are # designed to be used as identifiers, instead of text or data. # -# You can create a \String object explicitly with: +# You can create a +String+ object explicitly with: # # - A {string literal}[rdoc-ref:syntax/literals.rdoc@String+Literals]. # - A {heredoc literal}[rdoc-ref:syntax/literals.rdoc@Here+Document+Literals]. @@ -14,7 +14,7 @@ # # - \Method #String. # -# Some \String methods modify +self+. +# Some +String+ methods modify +self+. # Typically, a method whose name ends with <tt>!</tt> modifies +self+ # and returns +self+; # often a similarly named method (without the <tt>!</tt>) @@ -64,14 +64,14 @@ # # 'THX1138'.gsub('\d+', '00') # => "THX1138" # -# <b>\String +replacement+</b> +# <b>+String+ +replacement+</b> # # If +replacement+ is a string, that string will determine # the replacing string that is to be substituted for the matched text. # # Each of the examples above uses a simple string as the replacing string. # -# \String +replacement+ may contain back-references to the pattern's captures: +# +String+ +replacement+ may contain back-references to the pattern's captures: # # - <tt>\n</tt> (_n_ a non-negative integer) refers to <tt>$n</tt>. # - <tt>\k<name></tt> refers to the named capture +name+. @@ -139,7 +139,7 @@ # # == Whitespace in Strings # -# In class \String, _whitespace_ is defined as a contiguous sequence of characters +# In class +String+, _whitespace_ is defined as a contiguous sequence of characters # consisting of any mixture of the following: # # - NL (null): <tt>"\x00"</tt>, <tt>"\u0000"</tt>. @@ -157,7 +157,7 @@ # - #rstrip, #rstrip!: strip trailing whitespace. # - #strip, #strip!: strip leading and trailing whitespace. # -# == \String Slices +# == +String+ Slices # # A _slice_ of a string is a substring that is selected by certain criteria. # @@ -290,7 +290,7 @@ # # <b><tt>string[substring]</tt></b> # -# When the single \String argument +substring+ is given, +# When the single +String+ argument +substring+ is given, # returns the substring from +self+ if found, otherwise +nil+: # # 'foo'['oo'] # => "oo" @@ -298,12 +298,12 @@ # # == What's Here # -# First, what's elsewhere. \Class \String: +# First, what's elsewhere. \Class +String+: # # - Inherits from {class Object}[rdoc-ref:Object@What-27s+Here]. # - Includes {module Comparable}[rdoc-ref:Comparable@What-27s+Here]. # -# Here, class \String provides methods that are useful for: +# Here, class +String+ provides methods that are useful for: # # - {Creating a String}[rdoc-ref:String@Methods+for+Creating+a+String] # - {Frozen/Unfrozen Strings}[rdoc-ref:String@Methods+for+a+Frozen-2FUnfrozen+String] @@ -314,7 +314,7 @@ # - {Converting to Non-String}[rdoc-ref:String@Methods+for+Converting+to+Non--5CString] # - {Iterating}[rdoc-ref:String@Methods+for+Iterating] # -# === Methods for Creating a \String +# === Methods for Creating a +String+ # # - ::new: Returns a new string. # - ::try_convert: Returns a new string created from a given object. @@ -374,7 +374,7 @@ # - #casecmp?: Returns +true+ if the string is equal to a given string after Unicode case folding; # +false+ otherwise. # -# === Methods for Modifying a \String +# === Methods for Modifying a +String+ # # Each of these methods modifies +self+. # @@ -428,9 +428,9 @@ # - #chop!: Removes trailing newline characters if found; otherwise removes the last character; # returns +self+ if any changes, +nil+ otherwise. # -# === Methods for Converting to New \String +# === Methods for Converting to New +String+ # -# Each of these methods returns a new \String based on +self+, +# Each of these methods returns a new +String+ based on +self+, # often just a modified copy of +self+. # # _Extension_ @@ -494,12 +494,12 @@ # # _Duplication_ # -# - #to_s, $to_str: If +self+ is a subclass of \String, returns +self+ copied into a \String; +# - #to_s, $to_str: If +self+ is a subclass of +String+, returns +self+ copied into a +String+; # otherwise, returns +self+. # -# === Methods for Converting to Non-\String +# === Methods for Converting to Non-+String+ # -# Each of these methods converts the contents of +self+ to a non-\String. +# Each of these methods converts the contents of +self+ to a non-+String+. # # <em>Characters, Bytes, and Clusters</em> # @@ -843,7 +843,7 @@ rb_gc_free_dsymbol(VALUE sym) * str.intern -> symbol * str.to_sym -> symbol * - * Returns the Symbol corresponding to <i>str</i>, creating the + * Returns the +Symbol+ corresponding to <i>str</i>, creating the * symbol if it did not previously exist. See Symbol#id2name. * * "Koala".intern #=> :Koala |