1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOC] Tweaks for Array#uniq! (#11950)

Browse Source
This commit is contained in:
Burdette Lamar 2024-10-25 09:52:22 -05:00 committed by GitHub
parent 5c1e43277e
commit 05f894aba2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
Notes: git 2024-10-25 14:52:41 +00:00 
Merged-By: peterzhu2118 <peter@peterzhu.ca>
1 changed files with 11 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
array.c
View File

@ -6155,32 +6155,30 @@ push_value(st_data_t key, st_data_t val, st_data_t ary)
/*
* call-seq:
* array.uniq! -> self or nil
* array.uniq! {|element| ... } -> self or nil
* uniq! -> self or nil
* uniq! {|element| ... } -> self or nil
*
* Removes duplicate elements from +self+, the first occurrence always being retained;
* returns +self+ if any elements removed, +nil+ otherwise.
*
* With no block given, identifies and removes elements using method <tt>eql?</tt>
* to compare.
*
* Returns +self+ if any elements removed:
* to compare elements:
*
* a = [0, 0, 1, 1, 2, 2]
* a.uniq! # => [0, 1, 2]
*
* Returns +nil+ if no elements removed.
* a.uniq! # => nil
*
* With a block given, calls the block for each element;
* identifies (using method <tt>eql?</tt>) and removes
* elements for which the block returns duplicate values.
*
* Returns +self+ if any elements removed:
* identifies and omits "duplicate" elements using method <tt>eql?</tt>
* to compare <i>block return values</i>;
* that is, an element is a duplicate if its block return value
* is the same as that of a previous element:
*
* a = ['a', 'aa', 'aaa', 'b', 'bb', 'bbb']
* a.uniq! {|element| element.size } # => ['a', 'aa', 'aaa']
* a.uniq! {|element| element.size } # => ["a", "aa", "aaa"]
* a.uniq! {|element| element.size } # => nil
*
* Returns +nil+ if no elements removed.
* Related: see {Methods for Deleting}[rdoc-ref:Array@Methods+for+Deleting].
*/
static VALUE
rb_ary_uniq_bang(VALUE ary)