diff options
author | matz <matz@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2009-07-16 05:10:18 +0000 |
---|---|---|
committer | matz <matz@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2009-07-16 05:10:18 +0000 |
commit | 57264a4fae07ab1caca704519c1f426145eafe93 (patch) | |
tree | e9b6efdc39f57ea21589aa11cb44b0bccf3ab462 /array.c | |
parent | 606ea39a3b03566079d49711ab8a7b53d447b938 (diff) | |
download | ruby-57264a4fae07ab1caca704519c1f426145eafe93.tar.gz |
* array.c (rb_ary_sample): RDoc update. a patch from Florian
Frank. [ruby-core:24347]
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@24141 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'array.c')
-rw-r--r-- | array.c | 8 |
1 files changed, 5 insertions, 3 deletions
@@ -3526,9 +3526,11 @@ rb_ary_shuffle(VALUE ary) * array.sample -> obj * array.sample(n) -> an_array * - * Choose a random element, or the random +n+ elements, from the array. - * If the array is empty, the first form returns <code>nil</code>, and the - * second form returns an empty array. + * Choose a random element or +n+ random elements from the array. The elements + * are chosen by using random and unique indices into the array in order to + * ensure that an element doesn't repeat itself unless the array already + * contained duplicate elements. If the array is empty the first form returns + * <code>nil</code> and the second form returns an empty array. * */ |