diff options
author | Jörn Zaefferer <joern.zaefferer@gmail.com> | 2007-01-17 10:03:31 +0000 |
---|---|---|
committer | Jörn Zaefferer <joern.zaefferer@gmail.com> | 2007-01-17 10:03:31 +0000 |
commit | 2d32400e3c7d226ef6d93fd91654768959695e80 (patch) | |
tree | d1ffd731b5ed3ee2c951b30820869d5182e130a3 | |
parent | 8bd7a3544dd77d92ac40e119fc6bc8a385622f25 (diff) | |
download | jquery-2d32400e3c7d226ef6d93fd91654768959695e80.tar.gz jquery-2d32400e3c7d226ef6d93fd91654768959695e80.zip |
Improved docs for $.merge, clearly stating that the first argument is altered.
-rw-r--r-- | src/jquery/jquery.js | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/src/jquery/jquery.js b/src/jquery/jquery.js index 0b0972e9c..4cc2a68fe 100644 --- a/src/jquery/jquery.js +++ b/src/jquery/jquery.js @@ -1556,21 +1556,22 @@ jQuery.extend({ /** * Merge two arrays together, removing all duplicates. * - * The new array is: All the results from the first array, followed - * by the unique results from the second array. + * The result is the altered first argument with + * the unique elements from the second array added. * * @example $.merge( [0,1,2], [2,3,4] ) * @result [0,1,2,3,4] * @desc Merges two arrays, removing the duplicate 2 * - * @example $.merge( [3,2,1], [4,3,2] ) - * @result [3,2,1,4] + * @example var array = [3,2,1]; + * $.merge( array, [4,3,2] ) + * @result array == [3,2,1,4] * @desc Merges two arrays, removing the duplicates 3 and 2 * * @name $.merge * @type Array - * @param Array first The first array to merge. - * @param Array second The second 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 into the first, unalterd. * @cat JavaScript */ merge: function(first, second) { |