From: "H.Yamamoto" Date: 2004-07-12T12:59:43+09:00 Subject: Re: [doc-patch] Another rdoc formatting error in array.c Hello. Johan Holmberg wrote: (2004/07/11 02:09) >I have discovered yet another formatting error that I missed the >previous time. See the patch below. I merged your patch to mine. Now looks more consistent. Would you check this? Index: array.c =================================================================== RCS file: /var/cvs/src/ruby/array.c,v retrieving revision 1.151 diff -u -w -b -p -r1.151 array.c --- array.c 9 Jul 2004 13:37:55 -0000 1.151 +++ array.c 12 Jul 2004 03:25:25 -0000 @@ -315,7 +315,7 @@ static VALUE rb_ary_replace _((VALUE, VA * call-seq: * Array.new(size=0, obj=nil) * Array.new(array) - * Array.new(size) {|i| ...} + * Array.new(size) {|index| block } * Returns a new array. In the first form, the new array is * empty. In the second it is created with _size_ copies of _obj_ @@ -762,15 +762,15 @@ rb_ary_subseq(ary, beg, len) /* * call-seq: - * array[int] => obj or nil + * array[index] => obj or nil * array[start, length] => an_array or nil * array[range] => an_array or nil - * array.slice(int) => obj or nil + * array.slice(index) => obj or nil * array.slice(start, length) => an_array or nil * array.slice(range) => an_array or nil * - * Element Reference---Returns the element at index _int_, - * or returns a subarray starting at index _start_ and + * Element Reference---Returns the element at _index_, + * or returns a subarray starting at _start_ and * continuing for _length_ elements, or returns a subarray * specified by _range_. * Negative indices count backward from the end of the @@ -839,12 +839,12 @@ rb_ary_aref(argc, argv, ary) /* * call-seq: - * array.at(int) #=> obj or nil + * array.at(index) #=> obj or nil * - * Returns the element at index int. A + * Returns the element at _index_. A * negative index counts from the end of _self_. Returns +nil+ - * if the index is out of range. See also Array.[]. - * (Array.at is slightly faster than Array.[], as it + * if the index is out of range. See also Array#[]. + * (Array#at is slightly faster than Array#[], as it * does not accept ranges and so on.) * * a = [ "a", "b", "c", "d", "e" ] @@ -919,7 +919,7 @@ rb_ary_last(argc, argv, ary) * call-seq: * array.fetch(index) => obj * array.fetch(index, default ) => obj - * array.fetch(index) {|i| block } => obj + * array.fetch(index) {|index| block } => obj * * Tries to return the element at position index. If the index * lies outside the array, the first form throws an @@ -1099,30 +1099,30 @@ rb_ary_update(ary, beg, len, rpl) /* * call-seq: - * array[int] = obj => obj - * array[start, length] = an_array => an_array - * array[range] = an_array => an_array + * array[index] = obj => obj + * array[start, length] = obj or an_array or nil => obj or an_array or nil + * array[range] = obj or an_array or nil => obj or an_array or nil * - * Element Assignment---Sets the element at index _int_, - * or replaces a subarray starting at index _start_ and + * Element Assignment---Sets the element at _index_, + * or replaces a subarray starting at _start_ and * continuing for _length_ elements, or replaces a subarray - * specified by _range_. If _int_ is greater than + * specified by _range_. If indices are greater than * the current capacity of the array, the array grows - * automatically. A negative _int_ will count backward + * automatically. A negative indices will count backward * from the end of the array. Inserts elements if _length_ is - * zero. If _an_array is +nil+, deletes elements from _self_. - * An +IndexError+ is raised if a + * zero. If +nil+ is used in the second and third form, + * deletes elements from _self_. An +IndexError+ is raised if a * negative index points past the beginning of the array. See also - * Array.push, and Array.unshift. + * Array#push, and Array#unshift. * * a = Array.new - * a[4] = "4"; - * a[0, 3] = [ 'a', 'b', 'c' ] - * a[1..2] = [ 1, 2 ]; - * a[0, 2] = "?"; - * a[0..2] = "A"; - * a[-1] = "Z"; - * a[1..-1] = nil; + * a[4] = "4"; #=> [nil, nil, nil, nil, "4"] + * a[0, 3] = [ 'a', 'b', 'c' ] #=> ["a", "b", "c", nil, "4"] + * a[1..2] = [ 1, 2 ] #=> ["a", 1, 2, nil, "4"] + * a[0, 2] = "?" #=> ["?", 2, nil, "4"] + * a[0..2] = "A" #=> ["A", "4"] + * a[-1] = "Z" #=> ["A", "Z"] + * a[1..-1] = nil #=> ["A"] */ static VALUE @@ -1743,8 +1743,8 @@ rb_ary_sort(ary) /* * call-seq: - * array.collect {|obj| block } -> an_array - * array.map {|obj| block } -> an_array + * array.collect {|item| block } -> an_array + * array.map {|item| block } -> an_array * * Invokes block once for each element of self. Creates a * new array containing the values returned by the block. @@ -1775,12 +1775,12 @@ rb_ary_collect(ary) /* * call-seq: - * array.collect! {|obj} ...} => array - * array.map! {|obj} ...} => array + * array.collect! {|item| block } => array + * array.map! {|item| block } => array * - * Invokes the block once for each element of _self_self, replacing the + * Invokes the block once for each element of _self_, replacing the * element with the value returned by _block_. - * See also Enumerable.collect. + * See also Enumerable#collect. * * a = [ "a", "b", "c", "d" ] * a.collect! {|x| x + "!" } @@ -1860,9 +1860,9 @@ rb_ary_values_at(argc, argv, ary) /* * call-seq: - * array.select {|i| block } -> an_array + * array.select {|item| block } -> an_array * - * Invokes the block passing in successive elements from arr, + * Invokes the block passing in successive elements from self, * returning an array containing those elements for which the block * returns a true value (equivalent to Enumerable#select). * @@ -1889,7 +1889,7 @@ rb_ary_select(ary) /* * call-seq: * array.delete(obj) => obj or nil - * array.delete(obj) {| | block } => obj or nil + * array.delete(obj) { block } => obj or nil * * Deletes items from self that are equal to obj. If * the item is not found, returns nil. If the optional @@ -1982,7 +1982,7 @@ rb_ary_delete_at_m(ary, pos) /* * call-seq: - * array.slice!(int) => obj or nil + * array.slice!(index) => obj or nil * array.slice!(start, length) => sub_array or nil * array.slice!(range) => sub_array or nil * @@ -2036,7 +2036,7 @@ rb_ary_slice_bang(argc, argv, ary) /* * call-seq: - * array.reject! {| | block } -> array or nil + * array.reject! {|item| block } -> array or nil * * Equivalent to Array#delete_if, deleting elements from * _self_ for which the block evaluates to true, but returns @@ -2066,7 +2066,7 @@ rb_ary_reject_bang(ary) /* * call-seq: - * arr.reject {|item| block } -> an_array + * array.reject {|item| block } -> an_array * * Returns a new array containing the items in _self_ * for which the block is not true. @@ -2234,6 +2234,7 @@ rb_ary_replace(copy, orig) /* * call-seq: * array.clear => array + * * Removes all elements from _self_. * * a = [ "a", "b", "c", "d", "e" ] @@ -2255,17 +2256,17 @@ rb_ary_clear(ary) /* * call-seq: - * array.fill(obj) -> array + * array.fill(obj) => array * array.fill(obj, start [, length]) => array * array.fill(obj, range ) => array - * array.fill {|i| block } => array - * array.fill(start [, length] ) {|i| block } => array - * array.fill(range) {|i| block } => array + * array.fill {|index| block } => array + * array.fill(start [, length] ) {|index| block } => array + * array.fill(range) {|index| block } => array * * The first three forms set the selected elements of self (which * may be the entire array) to obj. A start of * nil is equivalent to zero. A length of - * nil is equivalent to arr.length. The last three + * nil is equivalent to self.length. The last three * forms fill the array with the value of the block. The block is * passed the absolute index of each element to be filled. * @@ -2376,7 +2377,7 @@ rb_ary_plus(x, y) /* * call-seq: - * self.concat(other_array) => array + * array.concat(other_array) => array * * Appends the elements in other_array to _self_. * @@ -2453,7 +2454,7 @@ rb_ary_times(ary, times) * Returns the first contained array that matches (that * is, the first associated array), * or +nil+ if no match is found. - * See also Array.rassoc. + * See also Array#rassoc. * * s1 = [ "colors", "red", "blue", "green" ] * s2 = [ "letters", "a", "b", "c" ] @@ -2854,7 +2855,7 @@ rb_ary_uniq(ary) * array.compact! => array or nil * * Removes +nil+ elements from array. - * Returns +niL+ if no changes were made. + * Returns +nil+ if no changes were made. * [ "a", nil, "b", nil, "c" ].compact! #=> [ "a", "b", "c" ] * [ "a", "b", "c" ].compact! #=> nil */