Merge pull request fzaninotto#848 from sustmi/docs-clarify-random-ele…

…ments docs: Clarify that randomElements() does not repeat input elements
iTechDhaval · Mar 10, 2016 · 588da2f · 588da2f
2 parents 74accbb + 7978ddc
commit 588da2f
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/readme.md b/readme.md
@@ -107,6 +107,7 @@ Each of the generator properties (like `name`, `address`, and `lorem`) are calle
     randomFloat($nbMaxDecimals = NULL, $min = 0, $max = NULL) // 48.8932
     numberBetween($min = 1000, $max = 9000) // 8567
     randomLetter            // 'b'
+    // returns randomly ordered subsequence of a provided array
     randomElements($array = array ('a','b','c'), $count = 1) // array('c')
     randomElement($array = array ('a','b','c')) // 'b'
     shuffle('hello, world') // 'rlo,h eoldlw'

diff --git a/src/Faker/Provider/Base.php b/src/Faker/Provider/Base.php
@@ -156,7 +156,7 @@ public static function randomAscii()
     }
 
     /**
-     * Returns random elements from a provided array
+     * Returns randomly ordered subsequence of $count elements from a provided array
      *
      * @param  array            $array Array to take elements from. Defaults to a-f
      * @param  integer          $count Number of elements to take.