summaryrefslogtreecommitdiffstats
path: root/docs/content/en/functions/cond.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/content/en/functions/cond.md')
-rw-r--r--docs/content/en/functions/cond.md14
1 files changed, 5 insertions, 9 deletions
diff --git a/docs/content/en/functions/cond.md b/docs/content/en/functions/cond.md
index 30b853251..8f87563d9 100644
--- a/docs/content/en/functions/cond.md
+++ b/docs/content/en/functions/cond.md
@@ -1,30 +1,26 @@
---
-title: "cond"
-date: 2017-09-08
+title: cond
description: "Return one of two arguments, depending on the value of a third argument."
categories: [functions]
menu:
docs:
- parent: "functions"
+ parent: functions
signature: ["cond CONTROL VAR1 VAR2"]
-hugoversion: 0.27
relatedfuncs: [default]
-toc: false
-draft: false
---
`cond` returns *VAR1* if *CONTROL* is true, or *VAR2* if it is not.
Example:
-```
+```go-html-template
{{ cond (eq (len $geese) 1) "goose" "geese" }}
```
Would emit "goose" if the `$geese` array has exactly 1 item, or "geese" otherwise.
-{{% warning %}}
+{{% note %}}
Whenever you use a `cond` function, *both* variable expressions are *always* evaluated. This means that a usage like `cond false (div 1 0) 27` will throw an error because `div 1 0` will be evaluated *even though the condition is false*.
In other words, the `cond` function does *not* provide [short-circuit evaluation](https://en.wikipedia.org/wiki/Short-circuit_evaluation) and does *not* work like a normal [ternary operator](https://en.wikipedia.org/wiki/%3F:) that will pass over the first expression if the condition returns `false`.
-{{% /warning %}}
+{{% /note %}}