rename raise to throw in API docs

Author: tsnobip

packages/@rescript/runtime/Belt.res

@@ -99,7 +99,7 @@ One common confusion comes from the way Belt handles array access. It differs fr
 let letters = ["a", "b", "c"]
 let a = letters[0] // a == "a"
 let capitalA = Js.String.toUpperCase(a)
-let k = letters[10] // Raises an exception! The 10th index doesn't exist.
+let k = letters[10] // Throws an exception! The 10th index doesn't exist.
 ```
 
 Because Belt avoids exceptions and returns `options` instead, this code behaves differently:
@@ -114,7 +114,7 @@ let captialA = Js.String.toUpperCase(a) // Type error! This code will not compil
 let k = letters[10] // k == None
 ```
 
-Although we've fixed the problem where `k` raises an exception, we now have a type error when trying to capitalize `a`. There are a few things going on here:
+Although we've fixed the problem where `k` throws an exception, we now have a type error when trying to capitalize `a`. There are a few things going on here:
 
 - Reason transforms array index access to the function `Array.get`. So `letters[0]` is the same as `Array.get(letters, 0)`.
 - The compiler uses whichever `Array` module is in scope. If you `open Belt`, then it uses `Belt.Array`.

packages/@rescript/runtime/Belt_Array.resi

@@ -47,13 +47,13 @@ Belt.Array.get(["a", "b", "c"], -1) == None
 let get: (t<'a>, int) => option<'a>
 
 /**
-Raise an exception if `i` is out of range.
+Throw an exception if `i` is out of range.
 Otherwise return the value at index `i` in `arr`.
 */
 let getExn: (t<'a>, int) => 'a
 
 /**
-Raise an exception if `i` is out of range.
+Throw an exception if `i` is out of range.
 Otherwise return the value at index `i` in `arr`.
 */
 let getOrThrow: (t<'a>, int) => 'a
@@ -83,12 +83,12 @@ with `x`. Returning `false` means not updated due to out of range.
 let set: (t<'a>, int, 'a) => bool
 
 /**
-`setExn(arr, i, x)` raise an exception if `i` is out of range.
+`setExn(arr, i, x)` throw an exception if `i` is out of range.
 */
 let setExn: (t<'a>, int, 'a) => unit
 
 /**
-`setOrThrow(arr, i, x)` raise an exception if `i` is out of range.
+`setOrThrow(arr, i, x)` throw an exception if `i` is out of range.
 */
 let setOrThrow: (t<'a>, int, 'a) => unit
 
@@ -774,7 +774,7 @@ let eq: (t<'a>, t<'a>, ('a, 'a) => bool) => bool
 /**
 Unsafe `truncateToLengthUnsafe(xs, n)` sets length of array `xs` to `n`. If `n`
 is greater than the length of `xs`; the extra elements are set to `Js.Null_undefined.null`.
-If `n` is less than zero; raises a `RangeError`.
+If `n` is less than zero; throws a `RangeError`.
 
 ## Examples
 

packages/@rescript/runtime/Belt_List.res

@@ -494,9 +494,9 @@ let shuffle = xs => {
 /* fillAuxMap arr 0 x f; */
 /* J.array arr */
 
-/* TODO: best practice about raising excpetion
-   1. raise OCaml exception, no stacktrace
-   2. raise JS exception, how to pattern match
+/* TODO: best practice about raising exception
+   1. throw OCaml exception, no stacktrace
+   2. throw JS exception, how to pattern match
 */
 
 let rec reverseConcat = (l1, l2) =>

packages/@rescript/runtime/Belt_List.resi

@@ -63,7 +63,7 @@ Belt.List.head(list{1, 2, 3}) == Some(1)
 let head: t<'a> => option<'a>
 
 /**
-Same as `Belt.List.head` but raises an exception if `someList` is empty. Use
+Same as `Belt.List.head` but throws an exception if `someList` is empty. Use
 with care.
 
 ## Examples
@@ -72,7 +72,7 @@ with care.
 Belt.List.headExn(list{1, 2, 3}) == 1
 
 switch Belt.List.headExn(list{}) {
-// Raises an Error
+// Throws an Error
 | exception _ => assert(true)
 | _ => assert(false)
 }
@@ -81,7 +81,7 @@ switch Belt.List.headExn(list{}) {
 let headExn: t<'a> => 'a
 
 /**
-Same as `Belt.List.head` but raises an exception if `someList` is empty. Use
+Same as `Belt.List.head` but throws an exception if `someList` is empty. Use
 with care.
 
 ## Examples
@@ -90,7 +90,7 @@ with care.
 Belt.List.headOrThrow(list{1, 2, 3}) == 1
 
 switch Belt.List.headOrThrow(list{}) {
-// Raises an Error
+// Throws an Error
 | exception _ => assert(true)
 | _ => assert(false)
 }
@@ -113,7 +113,7 @@ Belt.List.tail(list{}) == None
 let tail: t<'a> => option<t<'a>>
 
 /**
-Same as `Belt.List.tail` but raises an exception if `someList` is empty. Use
+Same as `Belt.List.tail` but throws an exception if `someList` is empty. Use
 with care.
 
 ## Examples
@@ -122,7 +122,7 @@ with care.
 Belt.List.tailExn(list{1, 2, 3}) == list{2, 3}
 
 switch Belt.List.tailExn(list{}) {
-// Raises an Error
+// Throws an Error
 | exception _ => assert(true)
 | _ => assert(false)
 }
@@ -131,7 +131,7 @@ switch Belt.List.tailExn(list{}) {
 let tailExn: t<'a> => t<'a>
 
 /**
-Same as `Belt.List.tail` but raises an exception if `someList` is empty. Use
+Same as `Belt.List.tail` but throws an exception if `someList` is empty. Use
 with care.
 
 ## Examples
@@ -140,7 +140,7 @@ with care.
 Belt.List.tailOrThrow(list{1, 2, 3}) == list{2, 3}
 
 switch Belt.List.tailOrThrow(list{}) {
-// Raises an Error
+// Throws an Error
 | exception _ => assert(true)
 | _ => assert(false)
 }
@@ -178,7 +178,7 @@ abc->Belt.List.get(4) == None
 let get: (t<'a>, int) => option<'a>
 
 /**
-Same as `Belt.List.get` but raises an exception if `index` is larger than the
+Same as `Belt.List.get` but throws an exception if `index` is larger than the
 length. Use with care.
 
 ## Examples
@@ -189,7 +189,7 @@ let abc = list{"A", "B", "C"}
 abc->Belt.List.getExn(1) == "B"
 
 switch abc->Belt.List.getExn(4) {
-// Raises an Error
+// Throws an Error
 | exception _ => assert(true)
 | _ => assert(false)
 }
@@ -198,7 +198,7 @@ switch abc->Belt.List.getExn(4) {
 let getExn: (t<'a>, int) => 'a
 
 /**
-Same as `Belt.List.get` but raises an exception if `index` is larger than the
+Same as `Belt.List.get` but throws an exception if `index` is larger than the
 length. Use with care.
 
 ## Examples
@@ -209,7 +209,7 @@ let abc = list{"A", "B", "C"}
 abc->Belt.List.getOrThrow(1) == "B"
 
 switch abc->Belt.List.getOrThrow(4) {
-// Raises an Error
+// Throws an Error
 | exception _ => assert(true)
 | _ => assert(false)
 }

packages/@rescript/runtime/Belt_Map.resi

@@ -359,7 +359,7 @@ let getWithDefault: (t<'k, 'v, 'id>, 'k, 'v) => 'v
 
 See `Belt.Map.get`
 
-raise when `k` not exist
+throw when `k` not exist
 */
 let getExn: (t<'k, 'v, 'id>, 'k) => 'v
 
@@ -368,7 +368,7 @@ let getExn: (t<'k, 'v, 'id>, 'k) => 'v
 
 See `Belt.Map.get`
 
-raise when `k` not exist
+throw when `k` not exist
 */
 let getOrThrow: (t<'k, 'v, 'id>, 'k) => 'v
 
@@ -535,6 +535,6 @@ Returns the packed collection.
 let packIdData: (~id: id<'k, 'id>, ~data: Belt_MapDict.t<'k, 'v, 'id>) => t<'k, 'v, 'id>
 
 /**
-**raise** when invariant is not held
+**throw** when invariant is not held
 */
 let checkInvariantInternal: t<_> => unit

packages/@rescript/runtime/Belt_MapInt.resi

@@ -117,7 +117,7 @@ let getExn: (t<'v>, key) => 'v
 let getOrThrow: (t<'v>, key) => 'v
 
 /**
-**raise** when invariant is not held
+**throw** when invariant is not held
 */
 let checkInvariantInternal: t<_> => unit
 

packages/@rescript/runtime/Belt_MapString.resi

@@ -117,7 +117,7 @@ let getExn: (t<'v>, key) => 'v
 let getOrThrow: (t<'v>, key) => 'v
 
 /**
-**raise** when invariant is not held
+**throw** when invariant is not held
 */
 let checkInvariantInternal: t<_> => unit
 

packages/@rescript/runtime/Belt_MutableMap.resi

@@ -122,7 +122,7 @@ let getUndefined: (t<'k, 'a, 'id>, 'k) => Js.undefined<'a>
 let getWithDefault: (t<'k, 'a, 'id>, 'k, 'a) => 'a
 let getExn: (t<'k, 'a, 'id>, 'k) => 'a
 let getOrThrow: (t<'k, 'a, 'id>, 'k) => 'a
-/** Raise when invariant is not held. */
+/** Throw when invariant is not held. */
 let checkInvariantInternal: t<_> => unit
 
 /* ************************************************************************** */

packages/@rescript/runtime/Belt_MutableMapInt.resi

@@ -109,7 +109,7 @@ let getExn: (t<'a>, key) => 'a
 let getOrThrow: (t<'a>, key) => 'a
 
 /**
-  **raise** when invariant is not held
+  **Throw** when invariant is not held
 */
 let checkInvariantInternal: t<_> => unit
 

packages/@rescript/runtime/Belt_MutableMapString.resi

@@ -109,7 +109,7 @@ let getExn: (t<'a>, key) => 'a
 let getOrThrow: (t<'a>, key) => 'a
 
 /**
-  **raise** when invariant is not held
+  **throw** when invariant is not held
 */
 let checkInvariantInternal: t<_> => unit