rename toShuffled to shuffle and deprecate it

Author: tsnobip

lib/es6/List.js

@@ -646,7 +646,7 @@ function toArray(x) {
   return arr;
 }
 
-function toShuffled(xs) {
+function shuffle(xs) {
   let v = toArray(xs);
   $$Array.shuffle(v);
   return fromArray(v);
@@ -1298,6 +1298,8 @@ function zip(l1, l2) {
 
 let size = length;
 
+let toShuffled = shuffle;
+
 export {
   length,
   size,
@@ -1310,6 +1312,7 @@ export {
   getExn,
   make,
   fromInitializer,
+  shuffle,
   toShuffled,
   drop,
   take,

lib/js/List.js

@@ -646,7 +646,7 @@ function toArray(x) {
   return arr;
 }
 
-function toShuffled(xs) {
+function shuffle(xs) {
   let v = toArray(xs);
   $$Array.shuffle(v);
   return fromArray(v);
@@ -1298,6 +1298,8 @@ function zip(l1, l2) {
 
 let size = length;
 
+let toShuffled = shuffle;
+
 exports.length = length;
 exports.size = size;
 exports.head = head;
@@ -1309,6 +1311,7 @@ exports.get = get;
 exports.getExn = getExn;
 exports.make = make;
 exports.fromInitializer = fromInitializer;
+exports.shuffle = shuffle;
 exports.toShuffled = toShuffled;
 exports.drop = drop;
 exports.take = take;

runtime/List.res

@@ -485,12 +485,15 @@ let toArray = (x: list<_>) => {
   arr
 }
 
-let toShuffled = xs => {
+let shuffle = xs => {
   let v = toArray(xs)
   Array.shuffle(v)
   fromArray(v)
 }
 
+@deprecated("Use `shuffle` instead")
+let toShuffled = shuffle
+
 /* let rec fillAuxMap arr i x f =
   match x with
   | [] -> ()

runtime/List.resi

@@ -200,6 +200,17 @@ List.fromInitializer(~length=5, i => i * i) // list{0, 1, 4, 9, 16}
 */
 let fromInitializer: (~length: int, int => 'a) => list<'a>
 
+/**
+`shuffle(list)` returns a new list in random order.
+
+## Examples
+
+```rescript
+List.shuffle(list{1, 2, 3}) // list{2, 1, 3}
+```
+*/
+let shuffle: list<'a> => list<'a>
+
 /**
 `toShuffled(list)` returns a new list in random order.
 
@@ -209,6 +220,7 @@ let fromInitializer: (~length: int, int => 'a) => list<'a>
 List.toShuffled(list{1, 2, 3}) // list{2, 1, 3}
 ```
 */
+@deprecated("Use `shuffle` instead")
 let toShuffled: list<'a> => list<'a>
 
 /**