* array.c (rb_ary_select):

zzak · zzak · commit 1ae1b85e81bc · 2012-09-13T18:32:07.000Z
Update documentation for Array#select * enum.c (enum_find_all, enum_reject): Update documentation for Enumerable#find_all and Enumerable#reject Based on a patch by Jeff Saracco [Bug #6908] [ruby-core:47285] [Fixes #166 on github] git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@36964 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
diff --git a/ChangeLog b/ChangeLog
@@ -1,3 +1,12 @@
+Fri Sep 14 03:30:00 2012  Zachary Scott  <zzak@ruby-lang.org>
+
+	* array.c (rb_ary_select):
+	  Update documentation for Array#select
+	* enum.c (enum_find_all, enum_reject):
+	  Update documentation for Enumerable#find_all and Enumerable#reject
+	  Based on a patch by Jeff Saracco
+	  [Bug #6908] [ruby-core:47285] [Fixes #166 on github]
+
 Fri Sep 14 00:20:00 2012  Zachary Scott  <zzak@ruby-lang.org>
 
 	* signal.c (rb_f_kill):
diff --git a/array.c b/array.c
@@ -2408,16 +2408,17 @@ rb_ary_values_at(int argc, VALUE *argv, VALUE ary)
  *     ary.select { |item| block } -> new_ary
  *     ary.select                  -> Enumerator
  *
- *  Invokes the given block passing in successive elements from +self+,
- *  returning an array containing those elements for which the block returns
- *  a +true+ value.
- *
- *  See also Enumerable#select.
+ *  Returns a new array containing all elements of +ary+
+ *  for which the given +block+ returns a true value.
  *
  *  If no block is given, an Enumerator is returned instead.
  *
+ *     [1,2,3,4,5].select { |num|  num.even?  }   #=> [2, 4]
+ *
  *     a = %w{ a b c d e f }
  *     a.select { |v| v =~ /[aeiou]/ }  #=> ["a", "e"]
+ *
+ *  See also Enumerable#select.
  */
 
 static VALUE
diff --git a/enum.c b/enum.c
@@ -311,15 +311,17 @@ find_all_i(VALUE i, VALUE ary, int argc, VALUE *argv)
  *     enum.find_all                 -> an_enumerator
  *     enum.select                   -> an_enumerator
  *
- *  Returns an array containing all elements of <i>enum</i> for which
- *  <em>block</em> is not <code>false</code> (see also
- *  <code>Enumerable#reject</code>).
+ *  Returns an array containing all elements of +enum+
+ *  for which the given +block+ returns a true value.
  *
- *  If no block is given, an enumerator is returned instead.
+ *  If no block is given, an Enumerator is returned instead.
  *
  *
  *     (1..10).find_all { |i|  i % 3 == 0 }   #=> [3, 6, 9]
  *
+ *     [1,2,3,4,5].select { |num|  num.even?  }   #=> [2, 4]
+ *
+ *  See also Enumerable#reject.
  */
 
 static VALUE
@@ -351,13 +353,16 @@ reject_i(VALUE i, VALUE ary, int argc, VALUE *argv)
  *     enum.reject { |obj| block } -> array
  *     enum.reject                 -> an_enumerator
  *
- *  Returns an array for all elements of <i>enum</i> for which
- *  <em>block</em> is false (see also <code>Enumerable#find_all</code>).
+ *  Returns an array for all elements of +enum+ for which the given
+ *  +block+ returns false.
  *
- *  If no block is given, an enumerator is returned instead.
+ *  If no block is given, an Enumerator is returned instead.
  *
  *     (1..10).reject { |i|  i % 3 == 0 }   #=> [1, 2, 4, 5, 7, 8, 10]
  *
+ *     [1, 2, 3, 4, 5].reject { |num| num.even? } #=> [1, 3, 5]
+ *
+ *  See also Enumerable#find_all.
  */
 
 static VALUE

Original file line number	Diff line number	Diff line change
`@@ -311,15 +311,17 @@ find_all_i(VALUE i, VALUE ary, int argc, VALUE *argv)`
`311`	`311`	`* enum.find_all -> an_enumerator`
`312`	`312`	`* enum.select -> an_enumerator`
`313`	`313`	`*`
`314`		`- * Returns an array containing all elements of <i>enum</i> for which`
`315`		`- * <em>block</em> is not <code>false</code> (see also`
`316`		`- * <code>Enumerable#reject</code>).`
	`314`	`+ * Returns an array containing all elements of +enum+`
	`315`	`+ * for which the given +block+ returns a true value.`
`317`	`316`	`*`
`318`		`- * If no block is given, an enumerator is returned instead.`
	`317`	`+ * If no block is given, an Enumerator is returned instead.`
`319`	`318`	`*`
`320`	`319`	`*`
`321`	`320`	`* (1..10).find_all { \|i\| i % 3 == 0 } #=> [3, 6, 9]`
`322`	`321`	`*`
	`322`	`+ * [1,2,3,4,5].select { \|num\| num.even? } #=> [2, 4]`
	`323`	`+ *`
	`324`	`+ * See also Enumerable#reject.`
`323`	`325`	`*/`
`324`	`326`
`325`	`327`	`static VALUE`
`@@ -351,13 +353,16 @@ reject_i(VALUE i, VALUE ary, int argc, VALUE *argv)`
`351`	`353`	`* enum.reject { \|obj\| block } -> array`
`352`	`354`	`* enum.reject -> an_enumerator`
`353`	`355`	`*`
`354`		`- * Returns an array for all elements of <i>enum</i> for which`
`355`		`- * <em>block</em> is false (see also <code>Enumerable#find_all</code>).`
	`356`	`+ * Returns an array for all elements of +enum+ for which the given`
	`357`	`+ * +block+ returns false.`
`356`	`358`	`*`
`357`		`- * If no block is given, an enumerator is returned instead.`
	`359`	`+ * If no block is given, an Enumerator is returned instead.`
`358`	`360`	`*`
`359`	`361`	`* (1..10).reject { \|i\| i % 3 == 0 } #=> [1, 2, 4, 5, 7, 8, 10]`
`360`	`362`	`*`
	`363`	`+ * [1, 2, 3, 4, 5].reject { \|num\| num.even? } #=> [1, 3, 5]`
	`364`	`+ *`
	`365`	`+ * See also Enumerable#find_all.`
`361`	`366`	`*/`
`362`	`367`
`363`	`368`	`static VALUE`