]> git.maquefel.me Git - brevno-suite/hugo/commitdiff
docs: Improve examples of variadic math functions
authorJoe Mooring <joe.mooring@veriphor.com>
Sat, 11 Mar 2023 18:51:07 +0000 (10:51 -0800)
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Sun, 12 Mar 2023 09:32:01 +0000 (10:32 +0100)
docs/content/en/functions/math.md

index 56e76e084710e65eff2acf6e9b9b4cc889edca20..4abf34d1d517a05a80e7364b482ce8abed33cc34 100644 (file)
@@ -19,24 +19,23 @@ draft: false
 aliases: []
 ---
 
-| Function     | Description                                                                 | Example                          |
-|--------------|-----------------------------------------------------------------------------|----------------------------------|
-| `add`        | Adds multivalued numbers.                                                   | `{{add 1 2}}` &rarr; `3`         |
-|              | *If one of the numbers is a float, the result is a float.*                  | `{{add 1.1 2}}` &rarr; `3.1`     |
-| `sub`        | Subtracts multivalued numbers.                                              | `{{sub 3 2}}` &rarr; `1`         |
-|              | *If one of the numbers is a float, the result is a float.*                  | `{{sub 3 2.5}}` &rarr; `0.5`     |
-| `mul`        | Multiplies multivalued numbers.                                             | `{{mul 2 3}}` &rarr; `6`         |
-|              | *If one of the numbers is a float, the result is a float.*                  | `{{mul 2 3.1}}` &rarr; `6.2`     |
-| `div`        | Divides multivalued numbers.                                                | `{{div 6 3}}` &rarr; `2`         |
-|              |                                                                             | `{{div 6 4}}` &rarr; `1`         |
-|              | *If one of the numbers is a float, the result is a float.*                  | `{{div 6 4.0}}` &rarr; `1.5`     |
-| `mod`        | Modulus of two integers.                                                    | `{{mod 15 3}}` &rarr; `0`        |
-| `modBool`    | Boolean of modulus of two integers. Evaluates to `true` if result equals 0. | `{{modBool 15 3}}` &rarr; `true` |
-| `math.Ceil`  | Returns the least integer value greater than or equal to the given number.  | `{{math.Ceil 2.1}}` &rarr; `3`   |
-| `math.Floor` | Returns the greatest integer value less than or equal to the given number.  | `{{math.Floor 1.9}}` &rarr; `1`  |
-| `math.Log`   | Returns the natural logarithm of the given number.                          | `{{math.Log 42}}` &rarr; `3.737` |
-| `math.Max`   | Returns the greater of multivalued numbers.                                 | `{{math.Max 1 2}}` &rarr; `2`    |
-| `math.Min`   | Returns the smaller of multivalued numbers.                                 | `{{math.Min 1 2}}` &rarr; `1`    |
-| `math.Pow`   | Returns the first number raised to the power of the second number.          | `{{math.Pow 2 3}}` &rarr; `8`    |
-| `math.Round` | Returns the nearest integer, rounding half away from zero.                  | `{{math.Round 1.5}}` &rarr; `2`  |
-| `math.Sqrt`  | Returns the square root of the given number.                                | `{{math.Sqrt 81}}` &rarr; `9`    |
+| Function     | Description                                                                 | Example                             |
+|--------------|-----------------------------------------------------------------------------|-------------------------------------|
+| `add`        | Adds two or more numbers.                                                   | `{{ add 12 3 2 }}` &rarr; `17`      |
+|              | *If one of the numbers is a float, the result is a float.*                  | `{{ add 1.1 2 }}` &rarr; `3.1`      |
+| `sub`        | Subtracts one or more numbers from the first number.                        | `{{ sub 12 3 2 }}` &rarr; `7`       |
+|              | *If one of the numbers is a float, the result is a float.*                  | `{{ sub 3 2.5 }}` &rarr; `0.5`      |
+| `mul`        | Multiplies two or more numbers.                                             | `{{ mul 12 3 2 }}` &rarr; `72`      |
+|              | *If one of the numbers is a float, the result is a float.*                  | `{{ mul 2 3.1 }}` &rarr; `6.2`      |
+| `div`        | Divides the first number by one or more numbers.                            | `{{ div 12 3 2 }}` &rarr; `2`       |
+|              | *If one of the numbers is a float, the result is a float.*                  | `{{ div 6 4.0 }}` &rarr; `1.5`      |
+| `mod`        | Modulus of two integers.                                                    | `{{ mod 15 3 }}` &rarr; `0`         |
+| `modBool`    | Boolean of modulus of two integers. Evaluates to `true` if result equals 0. | `{{ modBool 15 3 }}` &rarr; `true`  |
+| `math.Ceil`  | Returns the least integer value greater than or equal to the given number.  | `{{ math.Ceil 2.1 }}` &rarr; `3`    |
+| `math.Floor` | Returns the greatest integer value less than or equal to the given number.  | `{{ math.Floor 1.9 }}` &rarr; `1`   |
+| `math.Log`   | Returns the natural logarithm of the given number.                          | `{{ math.Log 42 }}` &rarr; `3.737`  |
+| `math.Max`   | Returns the greater of two or more numbers.                                 | `{{ math.Max 12 3 2 }}` &rarr; `12` |  
+| `math.Min`   | Returns the smaller of two or more numbers.                                 | `{{ math.Min 12 3 2 }}` &rarr; `2`  |
+| `math.Pow`   | Returns the first number raised to the power of the second number.          | `{{ math.Pow 2 3 }}` &rarr; `8`     |
+| `math.Round` | Returns the nearest integer, rounding half away from zero.                  | `{{ math.Round 1.5 }}` &rarr; `2`   |
+| `math.Sqrt`  | Returns the square root of the given number.                                | `{{ math.Sqrt 81 }}` &rarr; `9`     |