From 4312d49c916c6a97e07507e50d225859e457d113 Mon Sep 17 00:00:00 2001 From: Joe Mooring Date: Fri, 27 Sep 2024 10:35:49 -0700 Subject: [PATCH] Update compare.Conditional documentation --- content/en/functions/compare/Conditional.md | 13 ++----------- 1 file changed, 2 insertions(+), 11 deletions(-) diff --git a/content/en/functions/compare/Conditional.md b/content/en/functions/compare/Conditional.md index 6d693770d..997b71e94 100644 --- a/content/en/functions/compare/Conditional.md +++ b/content/en/functions/compare/Conditional.md @@ -12,26 +12,17 @@ action: aliases: [/functions/cond] --- -The CONTROL argument is a boolean value that indicates whether the function should return ARG1 or ARG2. If CONTROL is `true`, the function returns ARG1. Otherwise, the function returns ARG2. +If CONTROL is truthy the function returns ARG1, otherwise it returns ARG2. ```go-html-template {{ $qty := 42 }} {{ cond (le $qty 3) "few" "many" }} → many ``` -The CONTROL argument must be either `true` or `false`. To cast a non-boolean value to boolean, pass it through the `not` operator twice. - -```go-html-template -{{ cond (42 | not | not) "truthy" "falsy" }} → truthy -{{ cond ("" | not | not) "truthy" "falsy" }} → falsy -``` - -{{% note %}} -Unlike [ternary operators] in other languages, the `cond` function does not perform [short-circuit evaluation]. The function evaluates both ARG1 and ARG2, regardless of the CONTROL value. +Unlike [ternary operators] in other languages, the `compare.Conditional` function does not perform [short-circuit evaluation]. It evaluates both ARG1 and ARG2 regardless of the CONTROL value. [short-circuit evaluation]: https://en.wikipedia.org/wiki/Short-circuit_evaluation [ternary operators]: https://en.wikipedia.org/wiki/Ternary_conditional_operator -{{% /note %}} Due to the absence of short-circuit evaluation, these examples throw an error: