diff --git a/ChangeLog b/ChangeLog index 43cd3b8153..25add802ca 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +Tue Feb 8 11:47:11 2011 Loren Sands-Ramshaw + + * array.c: documentation clarification in rotate, rotate!, + index, and rindex. [ruby-core:35144] + Wed Feb 9 09:45:43 2011 NAKAMURA Usaku * test/rdoc/test_rdoc_encoding.rb: remove unnecessary (and wrong) diff --git a/array.c b/array.c index 1c94396907..90dcf1c86e 100644 --- a/array.c +++ b/array.c @@ -1149,9 +1149,9 @@ rb_ary_fetch(int argc, VALUE *argv, VALUE ary) * ary.index {|item| block} -> int or nil * ary.index -> an_enumerator * - * Returns the index of the first object in +self+ such that is + * Returns the index of the first object in +self+ such that the object is * == to obj. If a block is given instead of an - * argument, returns first object for which block is true. + * argument, returns index of first object for which block is true. * Returns nil if no match is found. * See also Array#rindex. * @@ -1198,7 +1198,7 @@ rb_ary_index(int argc, VALUE *argv, VALUE ary) * * Returns the index of the last object in +self+ * == to obj. If a block is given instead of an - * argument, returns first object for which block is + * argument, returns index of first object for which block is * true, starting from the last object. * Returns nil if no match is found. * See also Array#index. @@ -1911,7 +1911,7 @@ rb_ary_rotate(VALUE ary, long cnt) * * Rotates +self+ in place so that the element at +cnt+ comes first, * and returns +self+. If +cnt+ is negative then it rotates in - * counter direction. + * the opposite direction. * * a = [ "a", "b", "c", "d" ] * a.rotate! #=> ["b", "c", "d", "a"] @@ -1936,11 +1936,11 @@ rb_ary_rotate_bang(int argc, VALUE *argv, VALUE ary) /* * call-seq: - * ary.rotate([cnt = 1]) -> new_ary + * ary.rotate(cnt=1) -> new_ary * - * Returns new array by rotating +self+, whose first element is the - * element at +cnt+ in +self+. If +cnt+ is negative then it rotates - * in counter direction. + * Returns new array by rotating +self+ so that the element at + * +cnt+ in +self+ is the first element of the new array. If +cnt+ + * is negative then it rotates in the opposite direction. * * a = [ "a", "b", "c", "d" ] * a.rotate #=> ["b", "c", "d", "a"]