aboutsummaryrefslogtreecommitdiffstats
path: root/array.c
diff options
context:
space:
mode:
authorstomar <stomar@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2018-11-04 11:40:32 +0000
committerstomar <stomar@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2018-11-04 11:40:32 +0000
commit139d9d819cdc2df640b5dab801348f5dda6a7a39 (patch)
tree01ccb4df0565bd952504aa3f712b288428833eef /array.c
parentbd20f031db80bb641c6527537ab3db831015730c (diff)
downloadruby-139d9d819cdc2df640b5dab801348f5dda6a7a39.tar.gz
array.c: [DOC] add docs for Array#{filter,filter!}
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@65528 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'array.c')
-rw-r--r--array.c8
1 files changed, 8 insertions, 0 deletions
diff --git a/array.c b/array.c
index 1eff5729c4..00061019b4 100644
--- a/array.c
+++ b/array.c
@@ -3139,6 +3139,8 @@ rb_ary_values_at(int argc, VALUE *argv, VALUE ary)
* call-seq:
* ary.select {|item| block} -> new_ary
* ary.select -> Enumerator
+ * ary.filter {|item| block} -> new_ary
+ * ary.filter -> Enumerator
*
* Returns a new array containing all elements of +ary+
* for which the given +block+ returns a true value.
@@ -3151,6 +3153,8 @@ rb_ary_values_at(int argc, VALUE *argv, VALUE ary)
* a.select {|v| v =~ /[aeiou]/ } #=> ["a", "e"]
*
* See also Enumerable#select.
+ *
+ * Array#filter is an alias for Array#select.
*/
static VALUE
@@ -3217,6 +3221,8 @@ select_bang_ensure(VALUE a)
* call-seq:
* ary.select! {|item| block } -> ary or nil
* ary.select! -> Enumerator
+ * ary.filter! {|item| block } -> ary or nil
+ * ary.filter! -> Enumerator
*
* Invokes the given block passing in successive elements from +self+,
* deleting elements for which the block returns a +false+ value.
@@ -3228,6 +3234,8 @@ select_bang_ensure(VALUE a)
* If no block is given, an Enumerator is returned instead.
*
* See also Array#keep_if.
+ *
+ * Array#filter! is an alias for Array#select!.
*/
static VALUE