Fix: outdated, incorrect documentation about the order of precedence for

operator modulus `%`. See #3189
josdejong · Apr 29, 2024 · 599f4ee · 599f4ee · zyw727725828 · May 14, 2024
1 parent da0c70e
commit 599f4ee
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 6 deletions.
diff --git a/HISTORY.md b/HISTORY.md
@@ -3,6 +3,8 @@
 # unpublished changes since 12.4.2
 
 - Fix: serialization of Units without a value, see #1240.
+- Fix: outdated, incorrect documentation about the order of precedence for
+  operator modulus `%`. See #3189.
 
 
 # 2024-04-24, 12.4.2

diff --git a/docs/expressions/syntax.md b/docs/expressions/syntax.md
@@ -114,8 +114,9 @@ Operators                         | Description
 `!`                               | Factorial
 `^`, `.^`                         | Exponentiation
 `+`, `-`, `~`, `not`              | Unary plus, unary minus, bitwise not, logical not
+`%`, `mod`                        | percentage, modulus
 See section below                 | Implicit multiplication
-`*`, `/`, `.*`, `./`, `%`, `mod`  | Multiply, divide, percentage, modulus
+`*`, `/`, `.*`, `./`              | Multiply, divide
 `+`, `-`                          | Add, subtract
 `:`                               | Range
 `to`, `in`                        | Unit conversion

diff --git a/src/expression/parse.js b/src/expression/parse.js
@@ -1024,7 +1024,7 @@ export const createParse = /* #__PURE__ */ factory(name, dependencies, ({
   }
 
   /**
-   * multiply, divide, modulus
+   * multiply, divide
    * @return {Node} node
    * @private
    */
@@ -1102,7 +1102,7 @@ export const createParse = /* #__PURE__ */ factory(name, dependencies, ({
    * @private
    */
   function parseRule2 (state) {
-    let node = parsePercentage(state)
+    let node = parseModulusPercentage(state)
     let last = node
     const tokenStates = []
 
@@ -1125,7 +1125,7 @@ export const createParse = /* #__PURE__ */ factory(name, dependencies, ({
             // Rewind once and build the "number / number" node; the symbol will be consumed later
             Object.assign(state, tokenStates.pop())
             tokenStates.pop()
-            last = parsePercentage(state)
+            last = parseModulusPercentage(state)
             node = new OperatorNode('/', 'divide', [node, last])
           } else {
             // Not a match, so rewind
@@ -1147,11 +1147,11 @@ export const createParse = /* #__PURE__ */ factory(name, dependencies, ({
   }
 
   /**
-   * percentage or mod
+   * modulus and percentage
    * @return {Node} node
    * @private
    */
-  function parsePercentage (state) {
+  function parseModulusPercentage (state) {
     let node, name, fn, params
 
     node = parseUnary(state)
@@ -1160,6 +1160,7 @@ export const createParse = /* #__PURE__ */ factory(name, dependencies, ({
       '%': 'mod',
       mod: 'mod'
     }
+
     while (hasOwnProperty(operators, state.token)) {
       name = state.token
       fn = operators[name]