Mention that math add/sub/mul/div functions can do float math too

Fixes https://github.com/gohugoio/hugoDocs/issues/373
This commit is contained in:
Kaushal Modi
2018-02-26 18:39:44 -05:00
parent 31632beeb8
commit 4917f06363
+16 -11
View File
@@ -20,14 +20,19 @@ draft: false
aliases: []
---
| Function | Description | Example |
|----------------|-------------------------------------------------------------------------------|----------------------------------|
| `add` | Adds two integers. | `{{add 1 2}}` → 3 |
| `div` | Divides two integers. | `{{div 6 3}}` → 2 |
| `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 |
| `mul` | Multiplies two integers. | `{{mul 2 3}}` → 6 |
| `sub` | Subtracts two integers. | `{{sub 3 2}}` → 1 |
| `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.Round` | Returns the nearest integer, rounding half away from zero. | `{{math.Round 1.5}}` → 2 |
| Function | Description | Example |
|--------------|-----------------------------------------------------------------------------|----------------------------------|
| `add` | Adds two 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 two 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 two 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 two 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.Round` | Returns the nearest integer, rounding half away from zero. | `{{math.Round 1.5}}` → `2` |