fix last remaining format issues in runtime docstrings

Author: zth

runtime/Belt.res

@@ -130,16 +130,15 @@ let letters = ["a", "b", "c"]
 let a = letters[0]
 
 // Use a switch statement:
-let capitalA =
-  switch a {
-  | Some(a) => Some(Js.String.toUpperCase(a))
-  | None => None
-  }
+let capitalA = switch a {
+| Some(a) => Some(Js.String.toUpperCase(a))
+| None => None
+}
 
 let k = letters[10] // k == None
 ```
 
-With that little bit of tweaking, our code now compiles successfully and is 100% free of runtime errors!
+With that little bit of tweaking, our code now compiles successfully and is 100% free of runtime errors\!
 
 ### A Special Encoding for Collection Safety
 
@@ -150,31 +149,25 @@ We use a phantom type to solve the problem:
 ## Examples
 
 ```rescript
-module Comparable1 =
-  Belt.Id.MakeComparable(
-    {
-      type t = (int, int)
-      let cmp = ((a0, a1), (b0, b1)) =>
-        switch Pervasives.compare(a0, b0) {
-        | 0 => Pervasives.compare(a1, b1)
-        | c => c
-        }
+module Comparable1 = Belt.Id.MakeComparable({
+  type t = (int, int)
+  let cmp = ((a0, a1), (b0, b1)) =>
+    switch Pervasives.compare(a0, b0) {
+    | 0 => Pervasives.compare(a1, b1)
+    | c => c
     }
-  )
+})
 
 let mySet1 = Belt.Set.make(~id=module(Comparable1))
 
-module Comparable2 =
-  Belt.Id.MakeComparable(
-    {
-      type t = (int, int)
-      let cmp = ((a0, a1), (b0, b1)) =>
-        switch Pervasives.compare(a0, b0) {
-        | 0 => Pervasives.compare(a1, b1)
-        | c => c
-        }
+module Comparable2 = Belt.Id.MakeComparable({
+  type t = (int, int)
+  let cmp = ((a0, a1), (b0, b1)) =>
+    switch Pervasives.compare(a0, b0) {
+    | 0 => Pervasives.compare(a1, b1)
+    | c => c
     }
-  )
+})
 
 let mySet2 = Belt.Set.make(~id=module(Comparable2))
 ```
@@ -184,8 +177,8 @@ Here, the compiler would infer `mySet1` and `mySet2` having different type, so e
 ## Examples
 
 ```rescript
-let mySet1: t<(int, int), Comparable1.identity>
-let mySet2: t<(int, int), Comparable2.identity>
+let mySet1: t<(int, int), Comparable1.identity> = %todo
+let mySet2: t<(int, int), Comparable2.identity> = %todo
 ```
 
 `Comparable1.identity` and `Comparable2.identity` are not the same using our encoding scheme.

runtime/Js.res

@@ -52,23 +52,6 @@ For more information about these argument orders and the trade-offs between them
 
 _Eventually, all modules in the Js namespace are going to be migrated to data-first though._
 
-In the meantime, there are several options for dealing with the data-last APIs:
-
-## Examples
-
-```rescript
-/* Js.String (data-last API used with pipe last operator) */
-Js.log(\"2019-11-10\" |> Js.String.split(\"-\"))
-Js.log(\"ReScript\" |> Js.String.startsWith(\"Re\"))
-
-/* Js.String (data-last API used with pipe first operator) */
-Js.log(\"2019-11-10\"->Js.String.split(\"-\", _))
-Js.log(\"ReScript\"->Js.String.startsWith(\"Re\", _))
-
-/* Js.String (data-last API used without any piping) */
-Js.log(Js.String.split(\"-\", \"2019-11-10\"))
-Js.log(Js.String.startsWith(\"Re\", \"ReScript\"))
-```
 ## Js.Xxx2 Modules
 
 Prefer `Js.Array2` over `Js.Array`, `Js.String2` over `Js.String`, etc. The latters are old modules.

runtime/Js_array.res

@@ -26,31 +26,6 @@
 Provides bindings to JavaScript’s `Array` functions. These bindings are
 optimized for pipe-last (`|>`), where the array to be processed is the last
 parameter in the function.
-
-Here is an example to find the sum of squares of all even numbers in an array.
-Without pipe last, we must call the functions in reverse order:
-
-## Examples
-
-```rescript
-let isEven = x => mod(x, 2) == 0
-let square = x => x * x
-let result = {
-  open Js.Array
-  reduce(\"+", 0, map(square, filter(isEven, [5, 2, 3, 4, 1])))
-}
-```
-
-With pipe last, we call the functions in the “natural” order:
-
-```rescript
-let isEven = x => mod(x, 2) == 0
-let square = x => x * x
-let result = {
-  open Js.Array
-  [5, 2, 3, 4, 1] |> filter(isEven) |> map(square) |> reduce("+", 0)
-}
-```
 */
 
 @@warning("-103")
@@ -1090,7 +1065,7 @@ external unsafe_get: (array<'a>, int) => 'a = "%array_unsafe_get"
 /**
 Sets the value at the given position in the array if the position is in bounds.
 If the index is out of bounds, well, “here there be dragons.“ *This function
-  modifies the original array.*
+modifies the original array.*
 
 ## Examples
 

runtime/Js_bigint.res

@@ -26,7 +26,7 @@ Js.BigInt.fromStringExn("0o11")
 try {
   Js.BigInt.fromStringExn("a")
 } catch {
-| _ => ...
+| _ => Console.error("Error parsing bigint")
 }
 ```
 */

runtime/Js_string.res

@@ -140,7 +140,7 @@ external get: (t, int) => t = ""
 /**
 `charAt(n, s)` gets the character at index `n` within string `s`. If `n` is
 negative or greater than the length of `s`, it returns the empty string. If the
-string contains characters outside the range \u0000-\uffff, it will return the
+string contains characters outside the range \\u0000-\\uffff, it will return the
 first 16-bit value at that position in the string.
 
 See [`String.charAt`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/charAt)
@@ -336,7 +336,7 @@ let indexOf = (arg1, obj) => indexOf(obj, arg1)
 /**
 `indexOfFrom(searchValue, start, str)` returns the position at which
 `searchValue` was found within `str` starting at character position `start`, or
--1 if `searchValue` is not found in that portion of `str`. The return value is
+\-1 if `searchValue` is not found in that portion of `str`. The return value is
 relative to the beginning of the string, no matter where the search started
 from.
 
@@ -424,7 +424,7 @@ let localeCompare = (arg1, obj) => localeCompare(obj, arg1)
 /**
 `match(regexp, str)` matches a `string` against the given `regexp`. If there is
 no match, it returns `None`. For regular expressions without the g modifier, if
-  there is a match, the return value is `Some(array)` where the array contains:
+there is a match, the return value is `Some(array)` where the array contains:
 - The entire matched string
 - Any capture groups if the regexp had parentheses
 
@@ -738,7 +738,7 @@ on MDN.
 ## Examples
 
 ```rescript
-Js.String.splitByRe(%re("/\s*[,;]\s*TODO/"), "art; bed , cog ;dad") == [
+Js.String.splitByRe(/\s*[,;]\s*TODO/, "art; bed , cog ;dad") == [
     Some("art"),
     Some("bed"),
     Some("cog"),
@@ -762,15 +762,15 @@ on MDN.
 ## Examples
 
 ```rescript
-Js.String.splitByReAtMost(%re("/\s*[,;]\s*TODO/"), ~limit=3, "one: two: three: four") == [
+Js.String.splitByReAtMost(/\s*[,;]\s*TODO/, ~limit=3, "one: two: three: four") == [
     Some("one"),
     Some("two"),
     Some("three"),
   ]
 
-Js.String.splitByReAtMost(%re("/\s*[,;]\s*TODO/"), ~limit=0, "one: two: three: four") == []
+Js.String.splitByReAtMost(/\s*[,;]\s*TODO/, ~limit=0, "one: two: three: four") == []
 
-Js.String.splitByReAtMost(%re("/\s*[,;]\s*TODO/"), ~limit=8, "one: two: three: four") == [
+Js.String.splitByReAtMost(/\s*[,;]\s*TODO/, ~limit=8, "one: two: three: four") == [
     Some("one"),
     Some("two"),
     Some("three"),
@@ -1000,7 +1000,7 @@ on MDN.
 ## Examples
 
 ```rescript
-Js.String.anchor("page1", "Page One") == "<a name="page1">Page One</a>"
+Js.String.anchor("page1", "Page One") == "<a name=\"page1\">Page One</a>"
 ```
 */
 @send
@@ -1018,7 +1018,7 @@ on MDN.
 ## Examples
 
 ```rescript
-Js.String.link("page2.html", "Go to page two") == "<a href="page2.html">Go to page two</a>"
+Js.String.link("page2.html", "Go to page two") == "<a href=\"page2.html\">Go to page two</a>"
 ```
 */
 @send

runtime/Js_string2.res

@@ -145,7 +145,7 @@ external get: (t, int) => t = ""
 /**
 `charAt(s, n)` gets the character at index `n` within string `s`. If `n` is
 negative or greater than the length of `s`, it returns the empty string. If the
-string contains characters outside the range \u0000-\uffff, it will return the
+string contains characters outside the range \\u0000-\\uffff, it will return the
 first 16-bit value at that position in the string.
 
 See [`String.charAt`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/charAt)
@@ -331,7 +331,7 @@ external indexOf: (t, t) => int = "indexOf"
 /**
 `indexOfFrom(str, searchValue, start)` returns the position at which
 `searchValue` was found within `str` starting at character position `start`, or
--1 if `searchValue` is not found in that portion of `str`. The return value is
+\-1 if `searchValue` is not found in that portion of `str`. The return value is
 relative to the beginning of the string, no matter where the search started
 from.
 
@@ -415,11 +415,11 @@ external localeCompare: (t, t) => float = "localeCompare"
 /**
 `match(str, regexp)` matches a `string` against the given `regexp`. If there is
 no match, it returns `None`. For regular expressions without the g modifier, if
-  there is a match, the return value is `Some(array)` where the array contains:
+there is a match, the return value is `Some(array)` where the array contains:
 - The entire matched string
 - Any capture groups if the regexp had parentheses
-For regular expressions with the g modifier, a matched expression returns
-`Some(array)` with all the matched substrings and no capture groups.
+  For regular expressions with the g modifier, a matched expression returns
+  `Some(array)` with all the matched substrings and no capture groups.
 
 See [`String.match`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/match)
 on MDN.
@@ -956,7 +956,7 @@ on MDN.
 ## Examples
 
 ```rescript
-Js.String2.anchor("Page One", "page1") == "<a name="page1">Page One</a>"
+Js.String2.anchor("Page One", "page1") == "<a name=\"page1\">Page One</a>"
 ```
 */
 @send
@@ -972,7 +972,7 @@ on MDN.
 ## Examples
 
 ```rescript
-Js.String2.link("Go to page two", "page2.html") == "<a href="page2.html">Go to page two</a>"
+Js.String2.link("Go to page two", "page2.html") == "<a href=\"page2.html\">Go to page two</a>"
 ```
 */
 @send