Remove (newly unneeded) remarks about aliases

This commit is contained in:
BurdetteLamar 2023-02-19 20:16:04 +00:00 committed by Jeremy Evans
parent 3d53827130
commit 3b239d2480
15 changed files with 2 additions and 149 deletions

12
array.c
View File

@ -1511,8 +1511,6 @@ rb_ary_cat(VALUE ary, const VALUE *argv, long len)
* a1 = a.push([:baz, :bat], [:bam, :bad])
* a1 # => [:foo, "bar", 2, [:baz, :bat], [:bam, :bad]]
*
* Array#append is an alias for Array#push.
*
* Related: #pop, #shift, #unshift.
*/
@ -1784,8 +1782,6 @@ ary_ensure_room_for_unshift(VALUE ary, int argc)
* a = [:foo, 'bar', 2]
* a.unshift(:bam, :bat) # => [:bam, :bat, :foo, "bar", 2]
*
* Array#prepend is an alias for Array#unshift.
*
* Related: #push, #pop, #shift.
*/
@ -1962,7 +1958,6 @@ static VALUE rb_ary_aref2(VALUE ary, VALUE b, VALUE e);
* # Raises TypeError (no implicit conversion of Symbol into Integer):
* a[:foo]
*
* Array#slice is an alias for Array#[].
*/
VALUE
@ -2215,8 +2210,6 @@ rb_ary_fetch(int argc, VALUE *argv, VALUE ary)
* e # => #<Enumerator: [:foo, "bar", 2]:index>
* e.each {|element| element == 'bar' } # => 1
*
* Array#find_index is an alias for Array#index.
*
* Related: #rindex.
*/
@ -3106,7 +3099,6 @@ inspect_ary(VALUE ary, VALUE dummy, int recur)
* a = [:foo, 'bar', 2]
* a.inspect # => "[:foo, \"bar\", 2]"
*
* Array#to_s is an alias for Array#inspect.
*/
static VALUE
@ -3811,7 +3803,6 @@ rb_ary_sort_by_bang(VALUE ary)
* a1 = a.map
* a1 # => #<Enumerator: [:foo, "bar", 2]:map>
*
* Array#collect is an alias for Array#map.
*/
static VALUE
@ -3846,7 +3837,6 @@ rb_ary_collect(VALUE ary)
* a1 = a.map!
* a1 # => #<Enumerator: [:foo, "bar", 2]:map!>
*
* Array#collect! is an alias for Array#map!.
*/
static VALUE
@ -3990,7 +3980,6 @@ rb_ary_values_at(int argc, VALUE *argv, VALUE ary)
* a = [:foo, 'bar', 2, :bam]
* a.select # => #<Enumerator: [:foo, "bar", 2, :bam]:select>
*
* Array#filter is an alias for Array#select.
*/
static VALUE
@ -4074,7 +4063,6 @@ select_bang_ensure(VALUE a)
* a = [:foo, 'bar', 2, :bam]
* a.select! # => #<Enumerator: [:foo, "bar", 2, :bam]:select!>
*
* Array#filter! is an alias for Array#select!.
*/
static VALUE

View File

@ -10,4 +10,3 @@ Contrast with String#bytesize:
'тест'.bytesize # => 8
'こんにちは'.bytesize # => 15
String#size is an alias for String#length.

4
enum.c
View File

@ -706,7 +706,6 @@ enum_flat_map(VALUE obj)
*
* (0..4).to_a # => [0, 1, 2, 3, 4]
*
* Enumerable#entries is an alias for Enumerable#to_a.
*/
static VALUE
enum_to_a(int argc, VALUE *argv, VALUE obj)
@ -1000,7 +999,6 @@ ary_inject_op(VALUE ary, VALUE init, VALUE op)
* "Memo: 3; element: 3"
* "Memo: 6; element: 4"
*
* Enumerable#reduce is an alias for Enumerable#inject.
*
*/
static VALUE
@ -2722,8 +2720,6 @@ member_i(RB_BLOCK_CALL_FUNC_ARGLIST(iter, args))
* {foo: 0, bar: 1, baz: 2}.include?('foo') # => false
* {foo: 0, bar: 1, baz: 2}.include?(0) # => false
*
* Enumerable#member? is an alias for Enumerable#include?.
*
*/
static VALUE

28
hash.c
View File

@ -2745,8 +2745,6 @@ keep_if_i(VALUE key, VALUE value, VALUE hash)
* hash.select {|key, value| ... } -> new_hash
* hash.select -> new_enumerator
*
* Hash#filter is an alias for Hash#select.
*
* Returns a new \Hash object whose entries are those for which the block returns a truthy value:
* h = {foo: 0, bar: 1, baz: 2}
* h.select {|key, value| value < 2 } # => {:foo=>0, :bar=>1}
@ -2775,8 +2773,6 @@ rb_hash_select(VALUE hash)
* hash.select! {|key, value| ... } -> self or nil
* hash.select! -> new_enumerator
*
* Hash#filter! is an alias for Hash#select!.
*
* Returns +self+, whose entries are those for which the block returns a truthy value:
* h = {foo: 0, bar: 1, baz: 2}
* h.select! {|key, value| value < 2 } => {:foo=>0, :bar=>1}
@ -2897,8 +2893,6 @@ NOINSERT_UPDATE_CALLBACK(hash_aset_str)
* hash[key] = value -> value
* hash.store(key, value)
*
* Hash#store is an alias for Hash#[]=.
* Associates the given +value+ with the given +key+; returns +value+.
*
* If the given +key+ exists, replaces its value with the given +value+;
@ -2985,9 +2979,9 @@ rb_hash_replace(VALUE hash, VALUE hash2)
* hash.size -> integer
*
* Returns the count of entries in +self+:
*
* {foo: 0, bar: 1, baz: 2}.length # => 3
*
* Hash#length is an alias for Hash#size.
*/
VALUE
@ -3118,8 +3112,6 @@ each_pair_i_fast(VALUE key, VALUE value, VALUE _)
* hash.each -> new_enumerator
* hash.each_pair -> new_enumerator
*
* Hash#each is an alias for Hash#each_pair.
* Calls the given block with each key-value pair; returns +self+:
* h = {foo: 0, bar: 1, baz: 2}
* h.each_pair {|key, value| puts "#{key}: #{value}"} # => {:foo=>0, :bar=>1, :baz=>2}
@ -3451,10 +3443,10 @@ inspect_hash(VALUE hash, VALUE dummy, int recur)
* hash.inspect -> new_string
*
* Returns a new \String containing the hash entries:
* h = {foo: 0, bar: 1, baz: 2}
* h.inspect # => "{:foo=>0, :bar=>1, :baz=>2}"
*
* Hash#to_s is an alias for Hash#inspect.
*/
static VALUE
@ -3641,8 +3633,6 @@ rb_hash_values(VALUE hash)
* hash.has_key?(key) -> true or false
* hash.key?(key) -> true or false
* hash.member?(key) -> true or false
* Methods #has_key?, #key?, and #member? are aliases for \#include?.
*
* Returns +true+ if +key+ is a key in +self+, otherwise +false+.
*/
@ -3670,8 +3660,6 @@ rb_hash_search_value(VALUE key, VALUE value, VALUE arg)
* hash.has_value?(value) -> true or false
* hash.value?(value) -> true or false
*
* Method #value? is an alias for \#has_value?.
*
* Returns +true+ if +value+ is a value in +self+, otherwise +false+.
*/
@ -3934,8 +3922,6 @@ rb_hash_update_block_i(VALUE key, VALUE value, VALUE hash)
*
* Each argument in +other_hashes+ must be a \Hash.
*
* \Method #update is an alias for \#merge!.
*
* With arguments and no block:
* * Returns +self+, after the given hashes are merged into it.
* * The given hashes are merged left to right.
@ -5335,8 +5321,6 @@ ruby_unsetenv(const char *name)
* ENV[name] = value -> value
* ENV.store(name, value) -> value
*
* ENV.store is an alias for ENV.[]=.
*
* Creates, updates, or deletes the named environment variable, returning the value.
* Both +name+ and +value+ may be instances of String.
* See {Valid Names and Values}[rdoc-ref:ENV@Valid+Names+and+Values].
@ -5738,8 +5722,6 @@ env_values_at(int argc, VALUE *argv, VALUE _)
* ENV.filter { |name, value| block } -> hash of name/value pairs
* ENV.filter -> an_enumerator
*
* ENV.filter is an alias for ENV.select.
*
* Yields each environment variable name and its value as a 2-element Array,
* returning a Hash of the names and values for which the block returns a truthy value:
* ENV.replace('foo' => '0', 'bar' => '1', 'baz' => '2')
@ -5783,8 +5765,6 @@ env_select(VALUE ehash)
* ENV.filter! { |name, value| block } -> ENV or nil
* ENV.filter! -> an_enumerator
*
* ENV.filter! is an alias for ENV.select!.
*
* Yields each environment variable name and its value as a 2-element Array,
* deleting each entry for which the block returns +false+ or +nil+,
* and returning ENV if any deletions made, or +nil+ otherwise:
@ -6095,8 +6075,6 @@ env_empty_p(VALUE _)
* ENV.member?(name) -> true or false
* ENV.key?(name) -> true or false
*
* ENV.has_key?, ENV.member?, and ENV.key? are aliases for ENV.include?.
*
* Returns +true+ if there is an environment variable with the given +name+:
* ENV.replace('foo' => '0', 'bar' => '1')
* ENV.include?('foo') # => true
@ -6577,8 +6555,6 @@ env_update_block_i(VALUE key, VALUE val, VALUE _)
* ENV.merge!(*hashes) -> ENV
* ENV.merge!(*hashes) { |name, env_val, hash_val| block } -> ENV
*
* ENV.update is an alias for ENV.merge!.
*
* Adds to ENV each key/value pair in the given +hash+; returns ENV:
* ENV.replace('foo' => '0', 'bar' => '1')
* ENV.merge!('baz' => '2', 'bat' => '3') # => {"bar"=>"1", "bat"=>"3", "baz"=>"2", "foo"=>"0"}

13
io.c
View File

@ -2387,9 +2387,6 @@ rb_io_flush(VALUE io)
* f.close
*
* Related: IO#pos=, IO#seek.
*
* IO#pos is an alias for IO#tell.
*
*/
static VALUE
@ -2657,9 +2654,6 @@ io_fillbuf(rb_io_t *fptr)
* Note that this method reads data to the input byte buffer. So
* IO#sysread may not behave as you intend with IO#eof?, unless you
* call IO#rewind first (which is not available for some streams).
*
* IO#eof? is an alias for IO#eof.
*
*/
VALUE
@ -2850,8 +2844,6 @@ rb_io_fdatasync(VALUE io)
* File.open('t.txt').fileno # => 10
* f.close
*
* IO#to_i is an alias for IO#fileno.
*
*/
static VALUE
@ -4574,9 +4566,6 @@ io_readlines(const struct getline_arg *arg, VALUE io)
* "Fifth line"
*
* Returns an Enumerator if no block is given.
*
* IO#each is an alias for IO#each_line.
*
*/
static VALUE
@ -5200,8 +5189,6 @@ rb_io_ungetc(VALUE io, VALUE c)
* f = File.new('/dev/tty').isatty #=> true
* f.close
*
* IO#tty? is an alias for IO#isatty.
*
*/
static VALUE

View File

@ -694,8 +694,6 @@ num_div(VALUE x, VALUE y)
* (-r) % r2 # => (119/100)
* (-r) %-r2 # => (-21/100)
*
* Numeric#modulo is an alias for Numeric#%.
*
*/
static VALUE
@ -804,8 +802,6 @@ num_divmod(VALUE x, VALUE y)
* (-34.56).abs #=> 34.56
* -34.56.abs #=> 34.56
*
* Numeric#magnitude is an alias for Numeric#abs.
*
*/
static VALUE
@ -1328,8 +1324,6 @@ rb_float_div(VALUE x, VALUE y)
* f.quo(Rational(2, 1)) # => 1.57
* f.quo(Complex(2, 0)) # => (1.57+0.0i)
*
* Float#fdiv is an alias for Float#quo.
*
*/
static VALUE
@ -1416,8 +1410,6 @@ ruby_float_mod(double x, double y)
* 10.0 % 4.0 # => 2.0
* 10.0 % Rational(4, 1) # => 2.0
*
* Float#modulo is an alias for Float#%.
*
*/
static VALUE
@ -2600,7 +2592,6 @@ float_round_underflow(int ndigits, int binexp)
*
* (0.3 / 0.1).to_i # => 2 (!)
*
* Float#to_int is an alias for Float#to_i.
*/
static VALUE
@ -3704,8 +3695,6 @@ int_nobits_p(VALUE num, VALUE mask)
* 1.succ #=> 2
* -1.succ #=> 0
*
* Integer#next is an alias for Integer#succ.
*
* Related: Integer#pred (predecessor value).
*/
@ -3928,9 +3917,6 @@ rb_fix_to_s(VALUE x)
* 78546939656932.to_s(36) # => "rubyrules"
*
* Raises an exception if +base+ is out of range.
*
* Integer#inspect is an alias for Integer#to_s.
*
*/
MJIT_FUNC_EXPORTED VALUE
@ -4324,8 +4310,6 @@ fix_mod(VALUE x, VALUE y)
* 10 % 3.0 # => 1.0
* 10 % Rational(3, 1) # => (1/1)
*
* Integer#modulo is an alias for Integer#%.
*
*/
VALUE
rb_int_modulo(VALUE x, VALUE y)
@ -4644,9 +4628,6 @@ fix_equal(VALUE x, VALUE y)
* 1 == 1.0 #=> true
*
* Related: Integer#eql? (requires +other+ to be an \Integer).
*
* Integer#=== is an alias for Integer#==.
*
*/
VALUE

View File

@ -116,7 +116,6 @@ class Integer
# -12345.abs #=> 12345
# 12345.abs #=> 12345
#
# Integer#magnitude is an alias for Integer#abs.
def abs
Primitive.attr! 'inline'
Primitive.cexpr! 'rb_int_abs(self)'
@ -235,8 +234,6 @@ class Integer
# int.to_i -> integer
#
# Since +int+ is already an Integer, returns +self+.
#
# #to_int is an alias for #to_i.
def to_i
self
end
@ -318,8 +315,6 @@ class Float
# -34.56.abs #=> 34.56
# 34.56.abs #=> 34.56
#
# Float#magnitude is an alias for Float#abs.
#
def abs
Primitive.attr! 'inline'
Primitive.cexpr! 'rb_float_abs(self)'

View File

@ -3921,9 +3921,6 @@ rb_obj_dig(int argc, VALUE *argv, VALUE obj, VALUE notfound)
*
* For details on +format_string+, see
* {Format Specifications}[rdoc-ref:format_specifications.rdoc].
*
* Kernel#format is an alias for Kernel#sprintf.
*
*/
static VALUE

View File

@ -839,7 +839,6 @@ range_size(VALUE range)
* (1...4).to_a # => [1, 2, 3]
* ('a'..'d').to_a # => ["a", "b", "c", "d"]
*
* Range#entries is an alias for Range#to_a.
*/
static VALUE
@ -1760,8 +1759,6 @@ range_eqq(VALUE range, VALUE val)
* ('a'..'d').cover?('cc') # => true
*
* Related: Range#cover?.
*
* Range#member? is an alias for Range#include?.
*/
static VALUE

View File

@ -1232,7 +1232,6 @@ nurat_negative_p(VALUE self)
* (1/2r).abs #=> (1/2)
* (-1/2r).abs #=> (1/2)
*
* Rational#magnitude is an alias for Rational#abs.
*/
VALUE

11
re.c
View File

@ -1169,8 +1169,6 @@ match_names(VALUE match)
* # => #<MatchData "HX1138" 1:"H" 2:"X" 3:"113" 4:"8">
* m.size # => 5
*
* MatchData#length is an alias for MatchData.size.
*
*/
static VALUE
@ -3413,8 +3411,6 @@ reg_hash(VALUE re)
* /foo/ == Regexp.new('food') # => false
* /foo/ == Regexp.new("abc".force_encoding("euc-jp")) # => false
*
* Regexp#eql? is an alias for Regexp#==.
*
*/
VALUE
@ -3465,9 +3461,6 @@ match_hash(VALUE match)
* Returns +true+ if +object+ is another \MatchData object
* whose target string, regexp, match, and captures
* are the same as +self+, +false+ otherwise.
*
* MatchData#eql? is an alias for MatchData#==.
*
*/
static VALUE
@ -3895,8 +3888,6 @@ void rb_warn_deprecated_to_remove(const char *removal, const char *fmt, const ch
* r3 = Regexp.new(r, timeout: 3.14) # => /foo/m
* r3.timeout # => 3.14
*
* Regexp.compile is an alias for Regexp.new.
*
*/
static VALUE
@ -4090,8 +4081,6 @@ rb_reg_quote(VALUE str)
* r = Regexp.new(Regexp.escape(s)) # => /\\\\\\\*\\\?\\\{\\\}\\\./
* r.match(s) # => #<MatchData "\\\\\\*\\?\\{\\}\\.">
*
* Regexp.quote is an alias for Regexp.escape.
*
*/
static VALUE

View File

@ -2997,7 +2997,6 @@ str_uplus(VALUE str)
* while +dedup+ is better suitable for using the method in chains
* of calculations:
*
*
* @url_list.concat(urls.map(&:dedup))
*
*/
@ -4802,7 +4801,6 @@ static VALUE str_succ(VALUE str);
*
* ''.succ # => ""
*
* String#next is an alias for String#succ.
*/
VALUE
@ -4907,8 +4905,6 @@ str_succ(VALUE str)
* succ! -> self
*
* Equivalent to String#succ, but modifies +self+ in place; returns +self+.
*
* String#next! is an alias for String#succ!.
*/
static VALUE
@ -5451,8 +5447,6 @@ rb_str_aset(VALUE str, VALUE indx, VALUE val)
* s['lly'] = 'ncial' # => "ncial"
* s # => "financial"
*
* String#slice is an alias for String#[].
*
*/
static VALUE
@ -6588,9 +6582,6 @@ rb_str_to_f(VALUE str)
*
* Returns +self+ if +self+ is a \String,
* or +self+ converted to a \String if +self+ is a subclass of \String.
*
* String#to_str is an alias for String#to_s.
*
*/
static VALUE
@ -11464,9 +11455,6 @@ rb_str_unicode_normalized_p(int argc, VALUE *argv, VALUE str)
* symbol == object -> true or false
*
* Returns +true+ if +object+ is the same object as +self+, +false+ otherwise.
*
* Symbol#=== is an alias for Symbol#==.
*
*/
#define sym_equal rb_obj_equal
@ -11583,8 +11571,6 @@ sym_inspect(VALUE sym)
*
* :foo.to_s # => "foo"
*
* Symbol#id2name is an alias for Symbol#to_s.
*
* Related: Symbol#inspect, Symbol#name.
*/
@ -11614,8 +11600,6 @@ rb_sym_proc_call(ID mid, int argc, const VALUE *argv, int kw_splat, VALUE passed
*
* :foo.succ # => :fop
*
* Symbol#next is an alias for Symbol#succ.
*
* Related: String#succ.
*/
@ -11757,9 +11741,6 @@ sym_aref(int argc, VALUE *argv, VALUE sym)
* length -> integer
*
* Equivalent to <tt>self.to_s.length</tt>; see String#length.
*
* Symbol#size is an alias for Symbol#length.
*
*/
static VALUE

View File

@ -596,8 +596,6 @@ rb_struct_define_under(VALUE outer, const char *name, ...)
* Foo.new(foo: 0, bar: 1, baz: 2)
* # Raises ArgumentError: unknown keywords: baz
*
* \Method <tt>::[]</tt> is an alias for method <tt>::new</tt>.
*
* - \Method <tt>:inspect</tt> returns a string representation of the subclass:
*
* Foo.inspect
@ -1029,8 +1027,6 @@ inspect_struct(VALUE s, VALUE prefix, int recur)
* joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
* joe.inspect # => "#<struct Customer name=\"Joe Smith\", address=\"123 Maple, Anytown NC\", zip=12345>"
*
* Struct#to_s is an alias for Struct#inspect.
*
*/
static VALUE
@ -1049,8 +1045,6 @@ rb_struct_inspect(VALUE s)
* joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
* joe.to_a # => ["Joe Smith", "123 Maple, Anytown NC", 12345]
*
* Struct#values and Struct#deconstruct are aliases for Struct#to_a.
*
* Related: #members.
*/
@ -1372,8 +1366,6 @@ rb_struct_values_at(int argc, VALUE *argv, VALUE s)
* a # => [12345]
*
* With no block given, returns an Enumerator.
*
* Struct#filter is an alias for Struct#select.
*/
static VALUE
@ -1532,7 +1524,6 @@ rb_struct_eql(VALUE s, VALUE s2)
* joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
* joe.size #=> 3
*
* Struct#length is an alias for Struct#size.
*/
VALUE

View File

@ -4,8 +4,6 @@ class Symbol
#
# Returns +self+.
#
# Symbol#intern is an alias for Symbol#to_sym.
#
# Related: String#to_sym.
def to_sym
self

21
time.c
View File

@ -3660,8 +3660,6 @@ tmcmp(struct tm *a, struct tm *b)
* Raises an exception if the number of arguments is eight, nine,
* or greater than ten.
*
* Time.gm is an alias for Time.utc.
*
* Related: Time.local.
*
*/
@ -3713,8 +3711,6 @@ time_s_mktime(int argc, VALUE *argv, VALUE klass)
* Time.utc(1950, 1, 1, 0, 0, 0).to_i # => -631152000
* Time.utc(1990, 1, 1, 0, 0, 0).to_i # => 631152000
*
* Time#tv_sec is an alias for Time#to_i.
*
* Related: Time#to_f Time#to_r.
*/
@ -3794,8 +3790,6 @@ time_to_r(VALUE time)
* t.usec # => 548469
*
* Related: Time#subsec (returns exact subseconds).
*
* Time#tv_usec is an alias for Time#usec.
*/
static VALUE
@ -3823,8 +3817,6 @@ time_usec(VALUE time)
* t.nsec # => 321963700
*
* Related: Time#subsec (returns exact subseconds).
*
* Time#tv_nsec is an alias for Time#usec.
*/
static VALUE
@ -3943,8 +3935,6 @@ time_eql(VALUE time1, VALUE time2)
* # => 2000-01-01 20:15:01 UTC
* utc.utc? # => true
*
* Time#gmt? is an alias for Time#utc?.
*
* Related: Time.utc.
*/
@ -4096,8 +4086,6 @@ time_localtime_m(int argc, VALUE *argv, VALUE time)
* t.utc # => 2000-01-01 06:00:00 UTC
* t.utc? # => true
*
* Time#gmtime is an alias for Time#utc.
*
* Related: Time#getutc (returns a new converted \Time object).
*/
@ -4221,7 +4209,6 @@ time_getlocaltime(int argc, VALUE *argv, VALUE time)
* utc.utc? # => true
* utc == local # => true
*
* Time#getgm is an alias for Time#getutc.
*/
static VALUE
@ -4255,8 +4242,6 @@ static VALUE strftime_cstr(const char *fmt, size_t len, VALUE time, rb_encoding
* t.strftime('%a %b %e %T %Y') # => "Sun Dec 31 23:59:59 2000"
* t.strftime('%c') # => "Sun Dec 31 23:59:59 2000"
*
* Time#asctime is an alias for Time#ctime.
*
* Related: Time#to_s, Time#inspect:
*
* t.inspect # => "2000-12-31 23:59:59.5 +000001"
@ -4682,8 +4667,6 @@ time_hour(VALUE time)
* # => 2000-01-02 03:04:05 +000006
* t.mday # => 2
*
* Time#day is an alias for Time#mday.
*
* Related: Time#year, Time#hour, Time#min.
*/
@ -4708,8 +4691,6 @@ time_mday(VALUE time)
* # => 2000-01-02 03:04:05 +000006
* t.mon # => 1
*
* Time#month is an alias for Time#mday.
*
* Related: Time#year, Time#hour, Time#min.
*/
@ -4934,7 +4915,6 @@ time_yday(VALUE time)
* t.zone # => "Central Daylight Time"
* t.dst? # => true
*
* Time#isdst is an alias for Time#dst?.
*/
static VALUE
@ -4990,7 +4970,6 @@ time_zone(VALUE time)
* Time.utc(2000, 1, 1).utc_offset # => 0
* Time.local(2000, 1, 1).utc_offset # => -21600 # -6*3600, or minus six hours.
*
* Time#gmt_offset and Time#gmtoff are aliases for Time#utc_offset.
*/
VALUE