Clarify max size of _.sampleSize. [ci skp] [closes #1802]

This commit is contained in:
John-David Dalton
2016-01-15 02:13:23 -08:00
parent 6b19ca1c11
commit e752b26f9e

View File

@@ -7921,7 +7921,8 @@
}
/**
* Gets `n` random elements from `collection`.
* Gets `n` random elements at unique keys from `collection` up to the
* size of `collection`.
*
* @static
* @memberOf _
@@ -7931,8 +7932,11 @@
* @returns {Array} Returns the random elements.
* @example
*
* _.sampleSize([1, 2, 3, 4], 2);
* _.sampleSize([1, 2, 3], 2);
* // => [3, 1]
*
* _.sampleSize([1, 2, 3], 4);
* // => [2, 3, 1]
*/
function sampleSize(collection, n) {
var index = -1,