update documentation for select and reject

jeffsaracco · jeffsaracco · commit 14c05517a995 · 2012-08-22T19:52:53.000-04:00
diff --git a/array.c b/array.c
@@ -2408,13 +2408,13 @@ 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.
+ *  Returns a new array containing all elements of <i>ary</i>
+ *  for which <em>block</em> does not return <code>false</code> 
+ *  (see also <code>Enumerable#select</code>).
  *
- *  See also Enumerable#select.
+ *  If no block is given, an enumerator is returned instead.
  *
- *  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"]
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 <i>enum</i>
+ *  for which <em>block</em> does not return <code>false</code> 
+ *  (see also <code>Enumerable#reject</code>).
  *
  *  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]
+ *
  */
 
 static VALUE
@@ -352,12 +354,14 @@ reject_i(VALUE i, VALUE ary, int argc, VALUE *argv)
  *     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>).
+ *  <em>block</em> returns false (see also <code>Enumerable#find_all</code>).
  *
  *  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]
+ *
  */
 
 static VALUE

Original file line number	Diff line number	Diff line change
`@@ -2408,13 +2408,13 @@ rb_ary_values_at(int argc, VALUE *argv, VALUE ary)`
`2408`	`2408`	`* ary.select { \|item\| block } -> new_ary`
`2409`	`2409`	`* ary.select -> Enumerator`
`2410`	`2410`	`*`
`2411`		`- * Invokes the given block passing in successive elements from +self+,`
`2412`		`- * returning an array containing those elements for which the block returns`
`2413`		`- * a +true+ value.`
	`2411`	`+ * Returns a new array containing all elements of <i>ary</i>`
	`2412`	`+ * for which <em>block</em> does not return <code>false</code>`
	`2413`	`+ * (see also <code>Enumerable#select</code>).`
`2414`	`2414`	`*`
`2415`		`- * See also Enumerable#select.`
	`2415`	`+ * If no block is given, an enumerator is returned instead.`
`2416`	`2416`	`*`
`2417`		`- * If no block is given, an Enumerator is returned instead.`
	`2417`	`+ * [1,2,3,4,5].select { \|num\| num.even? } #=> [2, 4]`
`2418`	`2418`	`*`
`2419`	`2419`	`* a = %w{ a b c d e f }`
`2420`	`2420`	`* a.select { \|v\| v =~ /[aeiou]/ } #=> ["a", "e"]`
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 <i>enum</i>`
	`315`	`+ * for which <em>block</em> does not return <code>false</code>`
	`316`	`+ * (see also <code>Enumerable#reject</code>).`
`317`	`317`	`*`
`318`	`318`	`* If no block is given, an enumerator is returned instead.`
`319`	`319`	`*`
`320`	`320`	`*`
`321`	`321`	`* (1..10).find_all { \|i\| i % 3 == 0 } #=> [3, 6, 9]`
`322`	`322`	`*`
	`323`	`+ * [1,2,3,4,5].select { \|num\| num.even? } #=> [2, 4]`
	`324`	`+ *`
`323`	`325`	`*/`
`324`	`326`
`325`	`327`	`static VALUE`
`@@ -352,12 +354,14 @@ reject_i(VALUE i, VALUE ary, int argc, VALUE *argv)`
`352`	`354`	`* enum.reject -> an_enumerator`
`353`	`355`	`*`
`354`	`356`	`* 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>).`
	`357`	`+ * <em>block</em> returns false (see also <code>Enumerable#find_all</code>).`
`356`	`358`	`*`
`357`	`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`	`+ *`
`361`	`365`	`*/`
`362`	`366`
`363`	`367`	`static VALUE`