diff options
| author | Joe Mooring <joe.mooring@veriphor.com> | 2023-03-11 10:51:07 -0800 |
|---|---|---|
| committer | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2023-03-12 10:32:01 +0100 |
| commit | b6f44aaf1a5b80943e553bda2282d971e00e3d48 (patch) | |
| tree | 7799f04f19df4921cb58b3f4c1411f82881b4f14 | |
| parent | 84201e8d5d319399a868e64d20d7a40e5aae2023 (diff) | |
docs: Improve examples of variadic math functions
| -rw-r--r-- | docs/content/en/functions/math.md | 41 |
1 files changed, 20 insertions, 21 deletions
diff --git a/docs/content/en/functions/math.md b/docs/content/en/functions/math.md index 56e76e084..4abf34d1d 100644 --- a/docs/content/en/functions/math.md +++ b/docs/content/en/functions/math.md @@ -19,24 +19,23 @@ draft: false aliases: [] --- -| Function | Description | Example | -|--------------|-----------------------------------------------------------------------------|----------------------------------| -| `add` | Adds multivalued numbers. | `{{add 1 2}}` → `3` | -| | *If one of the numbers is a float, the result is a float.* | `{{add 1.1 2}}` → `3.1` | -| `sub` | Subtracts multivalued numbers. | `{{sub 3 2}}` → `1` | -| | *If one of the numbers is a float, the result is a float.* | `{{sub 3 2.5}}` → `0.5` | -| `mul` | Multiplies multivalued numbers. | `{{mul 2 3}}` → `6` | -| | *If one of the numbers is a float, the result is a float.* | `{{mul 2 3.1}}` → `6.2` | -| `div` | Divides multivalued numbers. | `{{div 6 3}}` → `2` | -| | | `{{div 6 4}}` → `1` | -| | *If one of the numbers is a float, the result is a float.* | `{{div 6 4.0}}` → `1.5` | -| `mod` | Modulus of two integers. | `{{mod 15 3}}` → `0` | -| `modBool` | Boolean of modulus of two integers. Evaluates to `true` if result equals 0. | `{{modBool 15 3}}` → `true` | -| `math.Ceil` | Returns the least integer value greater than or equal to the given number. | `{{math.Ceil 2.1}}` → `3` | -| `math.Floor` | Returns the greatest integer value less than or equal to the given number. | `{{math.Floor 1.9}}` → `1` | -| `math.Log` | Returns the natural logarithm of the given number. | `{{math.Log 42}}` → `3.737` | -| `math.Max` | Returns the greater of multivalued numbers. | `{{math.Max 1 2}}` → `2` | -| `math.Min` | Returns the smaller of multivalued numbers. | `{{math.Min 1 2}}` → `1` | -| `math.Pow` | Returns the first number raised to the power of the second number. | `{{math.Pow 2 3}}` → `8` | -| `math.Round` | Returns the nearest integer, rounding half away from zero. | `{{math.Round 1.5}}` → `2` | -| `math.Sqrt` | Returns the square root of the given number. | `{{math.Sqrt 81}}` → `9` | +| Function | Description | Example | +|--------------|-----------------------------------------------------------------------------|-------------------------------------| +| `add` | Adds two or more numbers. | `{{ add 12 3 2 }}` → `17` | +| | *If one of the numbers is a float, the result is a float.* | `{{ add 1.1 2 }}` → `3.1` | +| `sub` | Subtracts one or more numbers from the first number. | `{{ sub 12 3 2 }}` → `7` | +| | *If one of the numbers is a float, the result is a float.* | `{{ sub 3 2.5 }}` → `0.5` | +| `mul` | Multiplies two or more numbers. | `{{ mul 12 3 2 }}` → `72` | +| | *If one of the numbers is a float, the result is a float.* | `{{ mul 2 3.1 }}` → `6.2` | +| `div` | Divides the first number by one or more numbers. | `{{ div 12 3 2 }}` → `2` | +| | *If one of the numbers is a float, the result is a float.* | `{{ div 6 4.0 }}` → `1.5` | +| `mod` | Modulus of two integers. | `{{ mod 15 3 }}` → `0` | +| `modBool` | Boolean of modulus of two integers. Evaluates to `true` if result equals 0. | `{{ modBool 15 3 }}` → `true` | +| `math.Ceil` | Returns the least integer value greater than or equal to the given number. | `{{ math.Ceil 2.1 }}` → `3` | +| `math.Floor` | Returns the greatest integer value less than or equal to the given number. | `{{ math.Floor 1.9 }}` → `1` | +| `math.Log` | Returns the natural logarithm of the given number. | `{{ math.Log 42 }}` → `3.737` | +| `math.Max` | Returns the greater of two or more numbers. | `{{ math.Max 12 3 2 }}` → `12` | +| `math.Min` | Returns the smaller of two or more numbers. | `{{ math.Min 12 3 2 }}` → `2` | +| `math.Pow` | Returns the first number raised to the power of the second number. | `{{ math.Pow 2 3 }}` → `8` | +| `math.Round` | Returns the nearest integer, rounding half away from zero. | `{{ math.Round 1.5 }}` → `2` | +| `math.Sqrt` | Returns the square root of the given number. | `{{ math.Sqrt 81 }}` → `9` | |