Improved docs for $.merge, clearly stating that the first argument is altered.

This commit is contained in:
Jörn Zaefferer 2007-01-17 10:03:31 +00:00
parent 8bd7a3544d
commit 2d32400e3c

13
src/jquery/jquery.js vendored
View file

@ -1556,21 +1556,22 @@ jQuery.extend({
/** /**
* Merge two arrays together, removing all duplicates. * Merge two arrays together, removing all duplicates.
* *
* The new array is: All the results from the first array, followed * The result is the altered first argument with
* by the unique results from the second array. * the unique elements from the second array added.
* *
* @example $.merge( [0,1,2], [2,3,4] ) * @example $.merge( [0,1,2], [2,3,4] )
* @result [0,1,2,3,4] * @result [0,1,2,3,4]
* @desc Merges two arrays, removing the duplicate 2 * @desc Merges two arrays, removing the duplicate 2
* *
* @example $.merge( [3,2,1], [4,3,2] ) * @example var array = [3,2,1];
* @result [3,2,1,4] * $.merge( array, [4,3,2] )
* @result array == [3,2,1,4]
* @desc Merges two arrays, removing the duplicates 3 and 2 * @desc Merges two arrays, removing the duplicates 3 and 2
* *
* @name $.merge * @name $.merge
* @type Array * @type Array
* @param Array first The first array to merge. * @param Array first The first array to merge, the unique elements of second added.
* @param Array second The second array to merge. * @param Array second The second array to merge into the first, unalterd.
* @cat JavaScript * @cat JavaScript
*/ */
merge: function(first, second) { merge: function(first, second) {