Updating ArkScript std documentation

ArkScript-lang · Nov 1, 2024 · 17a07c3 · 17a07c3
1 parent b33c148
commit 17a07c3
Show file tree

Hide file tree

Showing 17 changed files with 43 additions and 19 deletions.
diff --git a/std/v4.0.0/Async.html b/std/v4.0.0/Async.html
@@ -124,7 +124,7 @@ <h2>await</h2>
     <footer id="page-footer">
         <p class="text-center">
             Copyright &copy; 2020-2024 Alexandre Plateau & Fabien Zoccola.<br> All rights reserved.<br>
-            <i>Last generation at 2024-10-01 01:51:56.810042</i>
+            <i>Last generation at 2024-11-01 01:51:32.696555</i>
         </p>
     </footer>
 

diff --git a/std/v4.0.0/Events.html b/std/v4.0.0/Events.html
@@ -212,7 +212,7 @@ <h2>removeListenersOfType</h2>
     <footer id="page-footer">
         <p class="text-center">
             Copyright &copy; 2020-2024 Alexandre Plateau & Fabien Zoccola.<br> All rights reserved.<br>
-            <i>Last generation at 2024-10-01 01:51:56.810042</i>
+            <i>Last generation at 2024-11-01 01:51:32.696555</i>
         </p>
     </footer>
 

diff --git a/std/v4.0.0/Exceptions.html b/std/v4.0.0/Exceptions.html
@@ -149,7 +149,7 @@ <h2>try</h2>
     <footer id="page-footer">
         <p class="text-center">
             Copyright &copy; 2020-2024 Alexandre Plateau & Fabien Zoccola.<br> All rights reserved.<br>
-            <i>Last generation at 2024-10-01 01:51:56.810042</i>
+            <i>Last generation at 2024-11-01 01:51:32.696555</i>
         </p>
     </footer>
 

diff --git a/std/v4.0.0/Functional.html b/std/v4.0.0/Functional.html
@@ -171,7 +171,7 @@ <h2>flip</h2>
     <footer id="page-footer">
         <p class="text-center">
             Copyright &copy; 2020-2024 Alexandre Plateau & Fabien Zoccola.<br> All rights reserved.<br>
-            <i>Last generation at 2024-10-01 01:51:56.810042</i>
+            <i>Last generation at 2024-11-01 01:51:32.696555</i>
         </p>
     </footer>
 

diff --git a/std/v4.0.0/IO.html b/std/v4.0.0/IO.html
@@ -319,7 +319,7 @@ <h2>io:removeFiles</h2>
     <footer id="page-footer">
         <p class="text-center">
             Copyright &copy; 2020-2024 Alexandre Plateau & Fabien Zoccola.<br> All rights reserved.<br>
-            <i>Last generation at 2024-10-01 01:51:56.810042</i>
+            <i>Last generation at 2024-11-01 01:51:32.696555</i>
         </p>
     </footer>
 

diff --git a/std/v4.0.0/Lazy.html b/std/v4.0.0/Lazy.html
@@ -103,7 +103,7 @@ <h2>lazy:eval</h2>
     <footer id="page-footer">
         <p class="text-center">
             Copyright &copy; 2020-2024 Alexandre Plateau & Fabien Zoccola.<br> All rights reserved.<br>
-            <i>Last generation at 2024-10-01 01:51:56.810042</i>
+            <i>Last generation at 2024-11-01 01:51:32.696555</i>
         </p>
     </footer>
 

diff --git a/std/v4.0.0/List.html b/std/v4.0.0/List.html
@@ -84,6 +84,8 @@
     <a href="#list:forall">list:forAll</a>
 </li><li class="nav-item">
     <a href="#list:any">list:any</a>
+</li><li class="nav-item">
+    <a href="#list:countif">list:countIf</a>
 </li><li class="nav-item">
     <a href="#list:reverse">list:reverse</a>
 </li><li class="nav-item">
@@ -462,7 +464,7 @@ <h2>list:any</h2>
 : 
 </div>
 <div><h4>Parameters</h4>
-<ul><li><code>_L</code>: the list to work on</li><li><code>_f</code>: the conditon</li></ul></div>
+<ul><li><code>_L</code>: the list to work on</li><li><code>_f</code>: the condition</li></ul></div>
 <div><h4>Author</h4>
 <a href="https://github.com/Gryfenfer97">@Gryfenfer97</a></div></div><div><h4>Example</h4>
 <pre>
@@ -471,6 +473,28 @@ <h2>list:any</h2>
 (let f (fun (e) (< e 3)))
 (print (list:any a f))  # true
 </code>
+</pre></div>
+    </div>
+</section><section id="list:countif">
+    <h2>list:countIf</h2>
+
+    <div class="inner-section">
+        <div><code>(let list:countIf (fun (_L _f) (...)))</code>
+<br>
+<div>Count the number of elements in a list that match a condition</div>
+<div><b>Note</b>
+: 
+</div>
+<div><h4>Parameters</h4>
+<ul><li><code>_L</code>: the list to work on</li><li><code>_f</code>: the condition</li></ul></div>
+<div><h4>Author</h4>
+<a href="https://github.com/SuperFola">@SuperFola</a></div></div><div><h4>Example</h4>
+<pre>
+<code class="rainbowjs" data-language="arkscript">
+(let lst [1 2 3 4 5 6 7 8 9])
+(let is_even (fun (e) (= 0 (mod e 2))))
+(print (count_if lst is_even))  # 4
+</code>
 </pre></div>
     </div>
 </section><section id="list:reverse">
@@ -606,7 +630,7 @@ <h2>list:setAt</h2>
     <footer id="page-footer">
         <p class="text-center">
             Copyright &copy; 2020-2024 Alexandre Plateau & Fabien Zoccola.<br> All rights reserved.<br>
-            <i>Last generation at 2024-10-01 01:51:56.810042</i>
+            <i>Last generation at 2024-11-01 01:51:32.696555</i>
         </p>
     </footer>
 

diff --git a/std/v4.0.0/Math.html b/std/v4.0.0/Math.html
@@ -489,7 +489,7 @@ <h2>math:complex-div</h2>
     <footer id="page-footer">
         <p class="text-center">
             Copyright &copy; 2020-2024 Alexandre Plateau & Fabien Zoccola.<br> All rights reserved.<br>
-            <i>Last generation at 2024-10-01 01:51:56.810042</i>
+            <i>Last generation at 2024-11-01 01:51:32.696555</i>
         </p>
     </footer>
 

diff --git a/std/v4.0.0/Mathematics.html b/std/v4.0.0/Mathematics.html
@@ -471,7 +471,7 @@ <h2>math:atanh</h2>
     <footer id="page-footer">
         <p class="text-center">
             Copyright &copy; 2020-2024 Alexandre Plateau & Fabien Zoccola.<br> All rights reserved.<br>
-            <i>Last generation at 2024-10-01 01:51:56.810042</i>
+            <i>Last generation at 2024-11-01 01:51:32.696555</i>
         </p>
     </footer>
 

diff --git a/std/v4.0.0/Range.html b/std/v4.0.0/Range.html
@@ -197,7 +197,7 @@ <h2>range:reduce</h2>
     <footer id="page-footer">
         <p class="text-center">
             Copyright &copy; 2020-2024 Alexandre Plateau & Fabien Zoccola.<br> All rights reserved.<br>
-            <i>Last generation at 2024-10-01 01:51:56.810042</i>
+            <i>Last generation at 2024-11-01 01:51:32.696555</i>
         </p>
     </footer>
 

diff --git a/std/v4.0.0/String.html b/std/v4.0.0/String.html
@@ -358,7 +358,7 @@ <h2>str:chr</h2>
     <footer id="page-footer">
         <p class="text-center">
             Copyright &copy; 2020-2024 Alexandre Plateau & Fabien Zoccola.<br> All rights reserved.<br>
-            <i>Last generation at 2024-10-01 01:51:56.810042</i>
+            <i>Last generation at 2024-11-01 01:51:32.696555</i>
         </p>
     </footer>
 

diff --git a/std/v4.0.0/Switch.html b/std/v4.0.0/Switch.html
@@ -104,7 +104,7 @@ <h2>switch</h2>
     <footer id="page-footer">
         <p class="text-center">
             Copyright &copy; 2020-2024 Alexandre Plateau & Fabien Zoccola.<br> All rights reserved.<br>
-            <i>Last generation at 2024-10-01 01:51:56.810042</i>
+            <i>Last generation at 2024-11-01 01:51:32.696555</i>
         </p>
     </footer>
 

diff --git a/std/v4.0.0/System.html b/std/v4.0.0/System.html
@@ -143,7 +143,7 @@ <h2>sys:exit</h2>
     <footer id="page-footer">
         <p class="text-center">
             Copyright &copy; 2020-2024 Alexandre Plateau & Fabien Zoccola.<br> All rights reserved.<br>
-            <i>Last generation at 2024-10-01 01:51:56.810042</i>
+            <i>Last generation at 2024-11-01 01:51:32.696555</i>
         </p>
     </footer>
 

diff --git a/std/v4.0.0/Testing.html b/std/v4.0.0/Testing.html
@@ -181,7 +181,7 @@ <h2>test:suite</h2>
 <pre>
 <code class="rainbowjs" data-language="arkscript">
 (test:suite name {
-    (set display_cases_success true)  # default: false, when true, display all the cases names on success and failures
+    (_suite.toggle_display_cases_success true)  # default: false, when true, display all the cases names on success and failures
     (test:eq 6 (my_function 1 2 3))
     (test:eq 128 (* 8 16))})
 </code>
@@ -199,7 +199,7 @@ <h2>test:suite</h2>
     <footer id="page-footer">
         <p class="text-center">
             Copyright &copy; 2020-2024 Alexandre Plateau & Fabien Zoccola.<br> All rights reserved.<br>
-            <i>Last generation at 2024-10-01 01:51:56.810042</i>
+            <i>Last generation at 2024-11-01 01:51:32.696555</i>
         </p>
     </footer>
 

diff --git a/std/v4.0.0/Time.html b/std/v4.0.0/Time.html
@@ -98,7 +98,7 @@ <h2>time</h2>
     <footer id="page-footer">
         <p class="text-center">
             Copyright &copy; 2020-2024 Alexandre Plateau & Fabien Zoccola.<br> All rights reserved.<br>
-            <i>Last generation at 2024-10-01 01:51:56.810042</i>
+            <i>Last generation at 2024-11-01 01:51:32.696555</i>
         </p>
     </footer>
 

diff --git a/std/v4.0.0/index.html b/std/v4.0.0/index.html
@@ -78,7 +78,7 @@ <h2>ArkScript v4.0.0 documentation</h2>
     <footer id="page-footer">
         <p class="text-center">
             Copyright &copy; 2020-2024 Alexandre Plateau & Fabien Zoccola.<br> All rights reserved.<br>
-            <i>Last generation at 2024-10-01 01:51:56.810042</i>
+            <i>Last generation at 2024-11-01 01:51:32.696555</i>
         </p>
     </footer>
 

diff --git a/std/v4.0.0/os.html b/std/v4.0.0/os.html
@@ -93,7 +93,7 @@ <h2>os:home_dir</h2>
     <footer id="page-footer">
         <p class="text-center">
             Copyright &copy; 2020-2024 Alexandre Plateau & Fabien Zoccola.<br> All rights reserved.<br>
-            <i>Last generation at 2024-10-01 01:51:56.810042</i>
+            <i>Last generation at 2024-11-01 01:51:32.696555</i>
         </p>
     </footer>