Document math functions new in v0.114.0 (#2108)

This commit is contained in:
Joe Mooring 2023-06-19 10:59:27 -07:00 committed by GitHub
parent 9f4cb040ee
commit a964d93cef
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -12,7 +12,7 @@ relatedfuncs: []
--- ---
| Function | Description | Example | | Function | Description | Example |
|--------------|-----------------------------------------------------------------------------|-------------------------------------| |-----------------|-----------------------------------------------------------------------------|---------------------------------------------------|
| `add` | Adds two or more numbers. | `{{ add 12 3 2 }}` → `17` | | `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` | | | *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` | | `sub` | Subtracts one or more numbers from the first number. | `{{ sub 12 3 2 }}` → `7` |
@ -27,8 +27,10 @@ relatedfuncs: []
| `math.Ceil` | Returns the least integer value greater than or equal to the given number. | `{{ math.Ceil 2.1 }}` → `3` | | `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.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.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.Max` | Returns the greater of all numbers. Accepts scalars, slices, or both. | `{{ math.Max 1 (slice 2 3) 4 }}` → `4` |
| `math.Min` | Returns the smaller of two or more numbers. | `{{ math.Min 12 3 2 }}` → `2` | | `math.Min` | Returns the smaller of all numbers. Accepts scalars, slices, or both. | `{{ math.Min 1 (slice 2 3) 4 }}` → `1` |
| `math.Product` | Returns the product of all numbers. Accepts scalars, slices, or both. | `{{ math.Product 1 (slice 2 3) 4 }}` → `24` |
| `math.Pow` | Returns the first number raised to the power of the second number. | `{{ math.Pow 2 3 }}` → `8` | | `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.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` | | `math.Sqrt` | Returns the square root of the given number. | `{{ math.Sqrt 81 }}` → `9` |
| `math.Sum` | Returns the sum of all numbers. Accepts scalars, slices, or both. | `{{ math.Sum 1 (slice 2 3) 4 }}` → `10` |