Fix documentation for shuffle

The implementation of shuffle is a pure function, so it returns a new array instead of shuffling the input in place.
This commit is contained in:
Bill Mei
2017-12-26 17:08:23 -08:00
parent 339767fdc3
commit 068b92d085

View File

@ -1,8 +1,8 @@
### shuffle
Randomizes the order of the values of an array, in place.
Randomizes the order of the values of an array, returning a new array.
Uses the Fisher-Yates algoritm to reorder the elements of the array, based on the [Lodash implimentation](https://github.com/lodash/lodash/blob/b2ea6b1cd251796dcb5f9700c4911a7b6223920b/shuffle.js)
Uses the Fisher-Yates algoritm to reorder the elements of the array, based on the [Lodash implementation](https://github.com/lodash/lodash/blob/b2ea6b1cd251796dcb5f9700c4911a7b6223920b/shuffle.js), but as a pure function.
```js
const shuffle = ([...arr]) => {