Skip to content

Commit bfcefd4

Browse files
bobzhangbobzhang
committed
update docs
1 parent 1779ba9 commit bfcefd4

16 files changed

+71
-71
lines changed

‎docs/api/Belt.Array.html‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -515,7 +515,7 @@ <h1>Module <a href="type_Belt.Array.html">Belt.Array</a></h1>
515515
<code class="code">offset</code> can be negative;and is evaluated as <code class="code">length arr - offset</code>
516516
<p>
517517

518-
<code class="code">fill arr offset:(-1) len:1 </code> means fill the last element,
518+
<code class="code">fill arr ~offset:(-1) ~len:1</code> means fill the last element,
519519
if the array does not have enough data;<code class="code">fill</code> will ignore it<br>
520520

521521
</div>
@@ -554,9 +554,9 @@ <h1>Module <a href="type_Belt.Array.html">Belt.Array</a></h1>
554554

555555
</div>
556556
<div class="examples">
557-
<pre class="example"> <pre class="codepre"><code class="code"> Belt.Array.blit ~src: v1 ~srcOffset: 4 ~dst: v2 ~dstOffset: 2 ~len: 3 -&gt;
557+
<pre class="example"> <pre class="codepre"><code class="code"> Belt.Array.blit ~src: v1 ~srcOffset: 4 ~dst: v2 ~dstOffset: 2 ~len: 3 |.
558558
[|20;21;14;15;16;25;26;27|]
559-
Belt.Array.blit ~src: v1 ~srcOffset: 4 ~dst: v1 ~dstOffset: 2 ~len: 3 -&gt;
559+
Belt.Array.blit ~src: v1 ~srcOffset: 4 ~dst: v1 ~dstOffset: 2 ~len: 3 |.
560560
[|10;11;14;15;16;15;16;17|]
561561
</code></pre> </pre>
562562
</div>
@@ -579,7 +579,7 @@ <h1>Module <a href="type_Belt.Array.html">Belt.Array</a></h1>
579579
<p>
580580

581581
Call <code class="code">f</code> on each element of <code class="code">xs</code> from the beginning to end. <code class="code">f</code> returns <code class="code">unit</code>;so no
582-
new array is created. Use <code class="code">foreach</code> when you are primarily concerned with repetitively
582+
new array is created. Use <code class="code">forEach</code> when you are primarily concerned with repetitively
583583
creating side effects.<br>
584584

585585
</div>
@@ -737,8 +737,8 @@ <h1>Module <a href="type_Belt.Array.html">Belt.Array</a></h1>
737737

738738
</div>
739739
<div class="examples">
740-
<pre class="example"> <pre class="codepre"><code class="code"> predicate [|1;2;3;4;5|] (fun x -&gt; if x mod 2 = 0) = ([|2;4|], [|1;2;3|]);;
741-
predicate [|1;2;3;4;5|] (fun x -&gt; if x mod 2 &lt;&gt; 0) = ([|1;2;3|], [|2;4|]);;
740+
<pre class="example"> <pre class="codepre"><code class="code"> partition [|1;2;3;4;5|] (fun x -&gt; x mod 2 = 0 ) = ([|2;4|], [|1;2;3|]);;
741+
partition [|1;2;3;4;5|] (fun x -&gt; x mod 2 &lt;&gt; 0 ) = ([|1;2;3|], [|2;4|]);;
742742
</code></pre> </pre>
743743
</div>
744744
</div>
@@ -935,9 +935,9 @@ <h1>Module <a href="type_Belt.Array.html">Belt.Array</a></h1>
935935

936936
</div>
937937
<div class="examples">
938-
<pre class="example"> <pre class="codepre"><code class="code"> let arr = [|"ant";"bee";"cat";"dog";"elk"|] in
939-
let () = truncateToLengthUnsafe arr 3 in
940-
arr = [|"ant";"bee";"cat"|] = true;;
938+
<pre class="example"> <pre class="codepre"><code class="code"> let arr = [|"ant";"bee";"cat";"dog";"elk"|];;
939+
let () = truncateToLengthUnsafe arr 3;;
940+
arr = [|"ant";"bee";"cat"|];;
941941
</code></pre> </pre>
942942
</div>
943943
</div>

‎docs/api/Belt.Result.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -130,8 +130,8 @@ <h1>Module <a href="type_Belt.Result.html">Belt.Result</a></h1>
130130

131131
</div>
132132
<div class="examples">
133-
<pre class="example"> <pre class="codepre"><code class="code"> getExn good = 42
134-
getExn bad (* raises exception *)
133+
<pre class="example"> <pre class="codepre"><code class="code"> getExn good = 42;;
134+
getExn bad;; (* raises exception *)
135135
</code></pre> </pre>
136136
</div>
137137
</div>
@@ -147,8 +147,8 @@ <h1>Module <a href="type_Belt.Result.html">Belt.Result</a></h1>
147147

148148
</div>
149149
<div class="examples">
150-
<pre class="example"> <pre class="codepre"><code class="code"> mapWithDefault good 0 (function x -&gt; x / 2) = 21
151-
mapWithDefault bad 0 (function x -&gt; x / 2) = 0
150+
<pre class="example"> <pre class="codepre"><code class="code"> mapWithDefault good 0 (fun x -&gt; x / 2) = 21
151+
mapWithDefault bad 0 (fun x -&gt; x / 2) = 0
152152
</code></pre> </pre>
153153
</div>
154154
</div>

‎docs/api/Belt.SortArray.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ <h1>Module <a href="type_Belt.SortArray.html">Belt.SortArray</a></h1>
156156
</div>
157157
</div>
158158
<div class="examples">
159-
<pre class="example"> <pre class="codepre"><code class="code"> isSorted [|1;1;2;3;4|] (fun x y -&gt; compare x y)) = true
159+
<pre class="example"> <pre class="codepre"><code class="code"> isSorted [|1;1;2;3;4|] (fun x y -&gt; compare x y) = true
160160
</code></pre> </pre>
161161
</div>
162162
</div>

‎docs/api/Belt_Array.html‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -513,7 +513,7 @@ <h1>Module <a href="type_Belt_Array.html">Belt_Array</a></h1>
513513
<code class="code">offset</code> can be negative;and is evaluated as <code class="code">length arr - offset</code>
514514
<p>
515515

516-
<code class="code">fill arr offset:(-1) len:1 </code> means fill the last element,
516+
<code class="code">fill arr ~offset:(-1) ~len:1</code> means fill the last element,
517517
if the array does not have enough data;<code class="code">fill</code> will ignore it<br>
518518

519519
</div>
@@ -552,9 +552,9 @@ <h1>Module <a href="type_Belt_Array.html">Belt_Array</a></h1>
552552

553553
</div>
554554
<div class="examples">
555-
<pre class="example"> <pre class="codepre"><code class="code"> Belt.Array.blit ~src: v1 ~srcOffset: 4 ~dst: v2 ~dstOffset: 2 ~len: 3 -&gt;
555+
<pre class="example"> <pre class="codepre"><code class="code"> Belt.Array.blit ~src: v1 ~srcOffset: 4 ~dst: v2 ~dstOffset: 2 ~len: 3 |.
556556
[|20;21;14;15;16;25;26;27|]
557-
Belt.Array.blit ~src: v1 ~srcOffset: 4 ~dst: v1 ~dstOffset: 2 ~len: 3 -&gt;
557+
Belt.Array.blit ~src: v1 ~srcOffset: 4 ~dst: v1 ~dstOffset: 2 ~len: 3 |.
558558
[|10;11;14;15;16;15;16;17|]
559559
</code></pre> </pre>
560560
</div>
@@ -577,7 +577,7 @@ <h1>Module <a href="type_Belt_Array.html">Belt_Array</a></h1>
577577
<p>
578578

579579
Call <code class="code">f</code> on each element of <code class="code">xs</code> from the beginning to end. <code class="code">f</code> returns <code class="code">unit</code>;so no
580-
new array is created. Use <code class="code">foreach</code> when you are primarily concerned with repetitively
580+
new array is created. Use <code class="code">forEach</code> when you are primarily concerned with repetitively
581581
creating side effects.<br>
582582

583583
</div>
@@ -735,8 +735,8 @@ <h1>Module <a href="type_Belt_Array.html">Belt_Array</a></h1>
735735

736736
</div>
737737
<div class="examples">
738-
<pre class="example"> <pre class="codepre"><code class="code"> predicate [|1;2;3;4;5|] (fun x -&gt; if x mod 2 = 0) = ([|2;4|], [|1;2;3|]);;
739-
predicate [|1;2;3;4;5|] (fun x -&gt; if x mod 2 &lt;&gt; 0) = ([|1;2;3|], [|2;4|]);;
738+
<pre class="example"> <pre class="codepre"><code class="code"> partition [|1;2;3;4;5|] (fun x -&gt; x mod 2 = 0 ) = ([|2;4|], [|1;2;3|]);;
739+
partition [|1;2;3;4;5|] (fun x -&gt; x mod 2 &lt;&gt; 0 ) = ([|1;2;3|], [|2;4|]);;
740740
</code></pre> </pre>
741741
</div>
742742
</div>
@@ -933,9 +933,9 @@ <h1>Module <a href="type_Belt_Array.html">Belt_Array</a></h1>
933933

934934
</div>
935935
<div class="examples">
936-
<pre class="example"> <pre class="codepre"><code class="code"> let arr = [|"ant";"bee";"cat";"dog";"elk"|] in
937-
let () = truncateToLengthUnsafe arr 3 in
938-
arr = [|"ant";"bee";"cat"|] = true;;
936+
<pre class="example"> <pre class="codepre"><code class="code"> let arr = [|"ant";"bee";"cat";"dog";"elk"|];;
937+
let () = truncateToLengthUnsafe arr 3;;
938+
arr = [|"ant";"bee";"cat"|];;
939939
</code></pre> </pre>
940940
</div>
941941
</div>

‎docs/api/Belt_Result.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -141,8 +141,8 @@ <h1>Module <a href="type_Belt_Result.html">Belt_Result</a></h1>
141141

142142
</div>
143143
<div class="examples">
144-
<pre class="example"> <pre class="codepre"><code class="code"> getExn good = 42
145-
getExn bad (* raises exception *)
144+
<pre class="example"> <pre class="codepre"><code class="code"> getExn good = 42;;
145+
getExn bad;; (* raises exception *)
146146
</code></pre> </pre>
147147
</div>
148148
</div>
@@ -158,8 +158,8 @@ <h1>Module <a href="type_Belt_Result.html">Belt_Result</a></h1>
158158

159159
</div>
160160
<div class="examples">
161-
<pre class="example"> <pre class="codepre"><code class="code"> mapWithDefault good 0 (function x -&gt; x / 2) = 21
162-
mapWithDefault bad 0 (function x -&gt; x / 2) = 0
161+
<pre class="example"> <pre class="codepre"><code class="code"> mapWithDefault good 0 (fun x -&gt; x / 2) = 21
162+
mapWithDefault bad 0 (fun x -&gt; x / 2) = 0
163163
</code></pre> </pre>
164164
</div>
165165
</div>

‎docs/api/Belt_SortArray.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ <h1>Module <a href="type_Belt_SortArray.html">Belt_SortArray</a></h1>
149149
</div>
150150
</div>
151151
<div class="examples">
152-
<pre class="example"> <pre class="codepre"><code class="code"> isSorted [|1;1;2;3;4|] (fun x y -&gt; compare x y)) = true
152+
<pre class="example"> <pre class="codepre"><code class="code"> isSorted [|1;1;2;3;4|] (fun x y -&gt; compare x y) = true
153153
</code></pre> </pre>
154154
</div>
155155
</div>

‎docs/api/Belt_internalMapInt.A.html‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -504,7 +504,7 @@ <h1>Module <a href="type_Belt_internalMapInt.A.html">Belt_internalMapInt.A</a></
504504
<code class="code">offset</code> can be negative;and is evaluated as <code class="code">length arr - offset</code>
505505
<p>
506506

507-
<code class="code">fill arr offset:(-1) len:1 </code> means fill the last element,
507+
<code class="code">fill arr ~offset:(-1) ~len:1</code> means fill the last element,
508508
if the array does not have enough data;<code class="code">fill</code> will ignore it<br>
509509

510510
</div>
@@ -543,9 +543,9 @@ <h1>Module <a href="type_Belt_internalMapInt.A.html">Belt_internalMapInt.A</a></
543543

544544
</div>
545545
<div class="examples">
546-
<pre class="example"> <pre class="codepre"><code class="code"> Belt.Array.blit ~src: v1 ~srcOffset: 4 ~dst: v2 ~dstOffset: 2 ~len: 3 -&gt;
546+
<pre class="example"> <pre class="codepre"><code class="code"> Belt.Array.blit ~src: v1 ~srcOffset: 4 ~dst: v2 ~dstOffset: 2 ~len: 3 |.
547547
[|20;21;14;15;16;25;26;27|]
548-
Belt.Array.blit ~src: v1 ~srcOffset: 4 ~dst: v1 ~dstOffset: 2 ~len: 3 -&gt;
548+
Belt.Array.blit ~src: v1 ~srcOffset: 4 ~dst: v1 ~dstOffset: 2 ~len: 3 |.
549549
[|10;11;14;15;16;15;16;17|]
550550
</code></pre> </pre>
551551
</div>
@@ -568,7 +568,7 @@ <h1>Module <a href="type_Belt_internalMapInt.A.html">Belt_internalMapInt.A</a></
568568
<p>
569569

570570
Call <code class="code">f</code> on each element of <code class="code">xs</code> from the beginning to end. <code class="code">f</code> returns <code class="code">unit</code>;so no
571-
new array is created. Use <code class="code">foreach</code> when you are primarily concerned with repetitively
571+
new array is created. Use <code class="code">forEach</code> when you are primarily concerned with repetitively
572572
creating side effects.<br>
573573

574574
</div>
@@ -726,8 +726,8 @@ <h1>Module <a href="type_Belt_internalMapInt.A.html">Belt_internalMapInt.A</a></
726726

727727
</div>
728728
<div class="examples">
729-
<pre class="example"> <pre class="codepre"><code class="code"> predicate [|1;2;3;4;5|] (fun x -&gt; if x mod 2 = 0) = ([|2;4|], [|1;2;3|]);;
730-
predicate [|1;2;3;4;5|] (fun x -&gt; if x mod 2 &lt;&gt; 0) = ([|1;2;3|], [|2;4|]);;
729+
<pre class="example"> <pre class="codepre"><code class="code"> partition [|1;2;3;4;5|] (fun x -&gt; x mod 2 = 0 ) = ([|2;4|], [|1;2;3|]);;
730+
partition [|1;2;3;4;5|] (fun x -&gt; x mod 2 &lt;&gt; 0 ) = ([|1;2;3|], [|2;4|]);;
731731
</code></pre> </pre>
732732
</div>
733733
</div>
@@ -924,9 +924,9 @@ <h1>Module <a href="type_Belt_internalMapInt.A.html">Belt_internalMapInt.A</a></
924924

925925
</div>
926926
<div class="examples">
927-
<pre class="example"> <pre class="codepre"><code class="code"> let arr = [|"ant";"bee";"cat";"dog";"elk"|] in
928-
let () = truncateToLengthUnsafe arr 3 in
929-
arr = [|"ant";"bee";"cat"|] = true;;
927+
<pre class="example"> <pre class="codepre"><code class="code"> let arr = [|"ant";"bee";"cat";"dog";"elk"|];;
928+
let () = truncateToLengthUnsafe arr 3;;
929+
arr = [|"ant";"bee";"cat"|];;
930930
</code></pre> </pre>
931931
</div>
932932
</div>

‎docs/api/Belt_internalMapInt.S.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ <h1>Module <a href="type_Belt_internalMapInt.S.html">Belt_internalMapInt.S</a></
140140
</div>
141141
</div>
142142
<div class="examples">
143-
<pre class="example"> <pre class="codepre"><code class="code"> isSorted [|1;1;2;3;4|] (fun x y -&gt; compare x y)) = true
143+
<pre class="example"> <pre class="codepre"><code class="code"> isSorted [|1;1;2;3;4|] (fun x y -&gt; compare x y) = true
144144
</code></pre> </pre>
145145
</div>
146146
</div>

‎docs/api/Belt_internalMapString.A.html‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -504,7 +504,7 @@ <h1>Module <a href="type_Belt_internalMapString.A.html">Belt_internalMapString.A
504504
<code class="code">offset</code> can be negative;and is evaluated as <code class="code">length arr - offset</code>
505505
<p>
506506

507-
<code class="code">fill arr offset:(-1) len:1 </code> means fill the last element,
507+
<code class="code">fill arr ~offset:(-1) ~len:1</code> means fill the last element,
508508
if the array does not have enough data;<code class="code">fill</code> will ignore it<br>
509509

510510
</div>
@@ -543,9 +543,9 @@ <h1>Module <a href="type_Belt_internalMapString.A.html">Belt_internalMapString.A
543543

544544
</div>
545545
<div class="examples">
546-
<pre class="example"> <pre class="codepre"><code class="code"> Belt.Array.blit ~src: v1 ~srcOffset: 4 ~dst: v2 ~dstOffset: 2 ~len: 3 -&gt;
546+
<pre class="example"> <pre class="codepre"><code class="code"> Belt.Array.blit ~src: v1 ~srcOffset: 4 ~dst: v2 ~dstOffset: 2 ~len: 3 |.
547547
[|20;21;14;15;16;25;26;27|]
548-
Belt.Array.blit ~src: v1 ~srcOffset: 4 ~dst: v1 ~dstOffset: 2 ~len: 3 -&gt;
548+
Belt.Array.blit ~src: v1 ~srcOffset: 4 ~dst: v1 ~dstOffset: 2 ~len: 3 |.
549549
[|10;11;14;15;16;15;16;17|]
550550
</code></pre> </pre>
551551
</div>
@@ -568,7 +568,7 @@ <h1>Module <a href="type_Belt_internalMapString.A.html">Belt_internalMapString.A
568568
<p>
569569

570570
Call <code class="code">f</code> on each element of <code class="code">xs</code> from the beginning to end. <code class="code">f</code> returns <code class="code">unit</code>;so no
571-
new array is created. Use <code class="code">foreach</code> when you are primarily concerned with repetitively
571+
new array is created. Use <code class="code">forEach</code> when you are primarily concerned with repetitively
572572
creating side effects.<br>
573573

574574
</div>
@@ -726,8 +726,8 @@ <h1>Module <a href="type_Belt_internalMapString.A.html">Belt_internalMapString.A
726726

727727
</div>
728728
<div class="examples">
729-
<pre class="example"> <pre class="codepre"><code class="code"> predicate [|1;2;3;4;5|] (fun x -&gt; if x mod 2 = 0) = ([|2;4|], [|1;2;3|]);;
730-
predicate [|1;2;3;4;5|] (fun x -&gt; if x mod 2 &lt;&gt; 0) = ([|1;2;3|], [|2;4|]);;
729+
<pre class="example"> <pre class="codepre"><code class="code"> partition [|1;2;3;4;5|] (fun x -&gt; x mod 2 = 0 ) = ([|2;4|], [|1;2;3|]);;
730+
partition [|1;2;3;4;5|] (fun x -&gt; x mod 2 &lt;&gt; 0 ) = ([|1;2;3|], [|2;4|]);;
731731
</code></pre> </pre>
732732
</div>
733733
</div>
@@ -924,9 +924,9 @@ <h1>Module <a href="type_Belt_internalMapString.A.html">Belt_internalMapString.A
924924

925925
</div>
926926
<div class="examples">
927-
<pre class="example"> <pre class="codepre"><code class="code"> let arr = [|"ant";"bee";"cat";"dog";"elk"|] in
928-
let () = truncateToLengthUnsafe arr 3 in
929-
arr = [|"ant";"bee";"cat"|] = true;;
927+
<pre class="example"> <pre class="codepre"><code class="code"> let arr = [|"ant";"bee";"cat";"dog";"elk"|];;
928+
let () = truncateToLengthUnsafe arr 3;;
929+
arr = [|"ant";"bee";"cat"|];;
930930
</code></pre> </pre>
931931
</div>
932932
</div>

‎docs/api/Belt_internalMapString.S.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ <h1>Module <a href="type_Belt_internalMapString.S.html">Belt_internalMapString.S
140140
</div>
141141
</div>
142142
<div class="examples">
143-
<pre class="example"> <pre class="codepre"><code class="code"> isSorted [|1;1;2;3;4|] (fun x y -&gt; compare x y)) = true
143+
<pre class="example"> <pre class="codepre"><code class="code"> isSorted [|1;1;2;3;4|] (fun x y -&gt; compare x y) = true
144144
</code></pre> </pre>
145145
</div>
146146
</div>

0 commit comments

Comments
 (0)