Improve ma.modulo documentation.

grame-cncm · Aug 26, 2024 · 069935a · 069935a
1 parent a28badb
commit 069935a
Show file tree

Hide file tree

Showing 5 changed files with 4 additions and 4 deletions.
diff --git a/docs/index.html b/docs/index.html
@@ -384,5 +384,5 @@ <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
 
 <!--
 MkDocs version : 1.4.3
-Build Date UTC : 2024-08-10 16:13:33.175168+00:00
+Build Date UTC : 2024-08-26 13:33:21.099567+00:00
 -->
diff --git a/docs/libs/maths/index.html b/docs/libs/maths/index.html
@@ -751,7 +751,7 @@ <h4 id="usage_42">Usage</h4>
 </ul>
 <hr />
 <h3 id="mamodulo"><code>(ma.)modulo</code></h3>
-<p>Modulus operation.</p>
+<p>Modulus operation using the <code>(x%y+y)%y</code> formula to ensures the result is always non-negative, even if <code>x</code> is negative.</p>
 <h4 id="usage_43">Usage</h4>
 <pre><code>modulo(x,y) : _
 </code></pre>

diff --git a/docs/search/search_index.json b/docs/search/search_index.json
diff --git a/docs/sitemap.xml.gz b/docs/sitemap.xml.gz
diff --git a/maths.lib b/maths.lib
@@ -635,7 +635,7 @@ decimal = frac;
 
 
 //-------------------------------`(ma.)modulo`---------------------------------------
-// Modulus operation.
+// Modulus operation using the `(x%y+y)%y` formula to ensures the result is always non-negative, even if `x` is negative.
 //
 // #### Usage
 //