summaryrefslogtreecommitdiffstats
path: root/docs/content/en/functions/compare
diff options
context:
space:
mode:
Diffstat (limited to 'docs/content/en/functions/compare')
-rw-r--r--docs/content/en/functions/compare/Conditional.md (renamed from docs/content/en/functions/compare/Cond.md)20
-rw-r--r--docs/content/en/functions/compare/Default.md94
-rw-r--r--docs/content/en/functions/compare/Eq.md21
-rw-r--r--docs/content/en/functions/compare/Ge.md21
-rw-r--r--docs/content/en/functions/compare/Gt.md21
-rw-r--r--docs/content/en/functions/compare/Le.md21
-rw-r--r--docs/content/en/functions/compare/Lt.md21
-rw-r--r--docs/content/en/functions/compare/Ne.md21
-rw-r--r--docs/content/en/functions/compare/_index.md12
9 files changed, 94 insertions, 158 deletions
diff --git a/docs/content/en/functions/compare/Cond.md b/docs/content/en/functions/compare/Conditional.md
index 4b92a893c..6d693770d 100644
--- a/docs/content/en/functions/compare/Cond.md
+++ b/docs/content/en/functions/compare/Conditional.md
@@ -1,19 +1,14 @@
---
title: compare.Conditional
-linkTitle: cond
description: Returns one of two arguments depending on the value of the control argument.
-categories: [functions]
+categories: []
keywords: []
-menu:
- docs:
- parent: functions
-function:
+action:
aliases: [cond]
+ related:
+ - functions/compare/Default
returnType: any
signatures: [compare.Conditional CONTROL ARG1 ARG2]
-relatedFunctions:
- - compare.Conditional
- - compare.Default
aliases: [/functions/cond]
---
@@ -21,14 +16,14 @@ The CONTROL argument is a boolean value that indicates whether the function shou
```go-html-template
{{ $qty := 42 }}
-{{ cond (le $qty 3) "few" "many" }} → "many"
+{{ 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"
+{{ cond (42 | not | not) "truthy" "falsy" }} → truthy
+{{ cond ("" | not | not) "truthy" "falsy" }} → falsy
```
{{% note %}}
@@ -38,7 +33,6 @@ Unlike [ternary operators] in other languages, the `cond` function does not perf
[ternary operators]: https://en.wikipedia.org/wiki/Ternary_conditional_operator
{{% /note %}}
-
Due to the absence of short-circuit evaluation, these examples throw an error:
```go-html-template
diff --git a/docs/content/en/functions/compare/Default.md b/docs/content/en/functions/compare/Default.md
index 24ad37ef2..1e6bd7968 100644
--- a/docs/content/en/functions/compare/Default.md
+++ b/docs/content/en/functions/compare/Default.md
@@ -1,88 +1,48 @@
---
title: compare.Default
-linkTitle: default
-description: Allows setting a default value that can be returned if a first value is not set.
-categories: [functions]
+description: Returns the second argument if set, else the first argument.
keywords: []
-menu:
- docs:
- parent: functions
-function:
+action:
aliases: [default]
+ related:
+ - functions/compare/Conditional
+ - functions/go-template/Or
returnType: any
signatures: [compare.Default DEFAULT INPUT]
-relatedFunctions:
- - compare.Conditional
- - compare.Default
aliases: [/functions/default]
---
-`default` checks whether a given value is set and returns a default value if it is not. *Set* in this context means different things depending on the data type:
+The `default` function returns the second argument if set, else the first argument.
-* non-zero for numeric types and times
-* non-zero length for strings, arrays, slices, and maps
-* any boolean or struct value
-* non-nil for any other types
+{{% note %}}
+When the second argument is the boolean `false` value, the `default` function returns `false`. All _other_ falsy values are considered unset.
-`default` function examples reference the following content page:
+{{% include "functions/go-template/_common/truthy-falsy.md" %}}
-{{< code file="content/posts/default-function-example.md" >}}
----
-title: Sane Defaults
-seo_title:
-date: 2017-02-18
-font:
-oldparam: The default function helps make your templating DRYer.
-newparam:
----
-{{< /code >}}
-
-`default` can be written in more than one way:
-
-```go-html-template
-{{ .Params.font | default "Roboto" }}
-{{ default "Roboto" .Params.font }}
-```
-
-Both of the above `default` function calls return `Roboto`.
-
-A `default` value, however, does not need to be hard coded like the previous example. The `default` value can be a variable or pulled directly from the front matter using dot notation:
-
-```go-html-template
-{{ $old := .Params.oldparam }}
-<p>{{ .Params.newparam | default $old }}</p>
-```
-
-Which would return:
-
-```html
-<p>The default function helps make your templating DRYer.</p>
-```
-
-And then using dot notation
-
-```go-html-template
-<title>{{ .Params.seo_title | default .Title }}</title>
-```
-
-Which would return
-
-```html
-<title>Sane Defaults</title>
-```
+To set a default value based on truthiness, use the [`or`] operator instead.
-The following have equivalent return values but are far less terse. This demonstrates the utility of `default`:
+[`or`]: /functions/go-template/or
+{{% /note %}}
-Using `if`:
+The `default` function returns the second argument if set:
```go-html-template
-<title>{{ if .Params.seo_title }}{{ .Params.seo_title }}{{ else }}{{ .Title }}{{ end }}</title>
-=> Sane Defaults
+{{ default 42 1 }} → 1
+{{ default 42 "foo" }} → foo
+{{ default 42 (dict "k" "v") }} → map[k:v]
+{{ default 42 (slice "a" "b") }} → [a b]
+{{ default 42 true }} → true
+
+<!-- As noted above, the boolean "false" is considered set -->
+{{ default 42 false }} → false
```
-Using `with`:
+The `default` function returns the first argument if the second argument is not set:
```go-html-template
-<title>{{ with .Params.seo_title }}{{ . }}{{ else }}{{ .Title }}{{ end }}</title>
-=> Sane Defaults
+{{ default 42 0 }} → 42
+{{ default 42 "" }} → 42
+{{ default 42 dict }} → 42
+{{ default 42 slice }} → 42
+{{ default 42 <nil> }} → 42
```
diff --git a/docs/content/en/functions/compare/Eq.md b/docs/content/en/functions/compare/Eq.md
index 010fc51b3..49350e676 100644
--- a/docs/content/en/functions/compare/Eq.md
+++ b/docs/content/en/functions/compare/Eq.md
@@ -1,23 +1,18 @@
---
title: compare.Eq
-linkTitle: eq
description: Returns the boolean truth of arg1 == arg2 || arg1 == arg3.
-categories: [functions]
+categories: []
keywords: []
-menu:
- docs:
- parent: functions
-function:
+action:
aliases: [eq]
+ related:
+ - functions/compare/Ge
+ - functions/compare/Gt
+ - functions/compare/Le
+ - functions/compare/Lt
+ - functions/compare/Ne
returnType: bool
signatures: ['compare.Eq ARG1 ARG2 [ARG...]']
-relatedFunctions:
- - compare.Eq
- - compare.Ge
- - compare.Gt
- - compare.Le
- - compare.Lt
- - compare.Ne
aliases: [/functions/eq]
---
diff --git a/docs/content/en/functions/compare/Ge.md b/docs/content/en/functions/compare/Ge.md
index 6bb48dd00..479ecf990 100644
--- a/docs/content/en/functions/compare/Ge.md
+++ b/docs/content/en/functions/compare/Ge.md
@@ -1,23 +1,18 @@
---
title: compare.Ge
-linkTitle: ge
description: Returns the boolean truth of arg1 >= arg2 && arg1 >= arg3.
-categories: [functions]
+categories: []
keywords: []
-menu:
- docs:
- parent: functions
-function:
+action:
aliases: [ge]
+ related:
+ - functions/compare/Eq
+ - functions/compare/Gt
+ - functions/compare/Le
+ - functions/compare/Lt
+ - functions/compare/Ne
returnType: bool
signatures: ['compare.Ge ARG1 ARG2 [ARG...]']
-relatedFunctions:
- - compare.Eq
- - compare.Ge
- - compare.Gt
- - compare.Le
- - compare.Lt
- - compare.Ne
aliases: [/functions/ge]
---
diff --git a/docs/content/en/functions/compare/Gt.md b/docs/content/en/functions/compare/Gt.md
index 4691718ef..0af289ce2 100644
--- a/docs/content/en/functions/compare/Gt.md
+++ b/docs/content/en/functions/compare/Gt.md
@@ -1,23 +1,18 @@
---
title: compare.Gt
-linkTitle: gt
description: Returns the boolean truth of arg1 > arg2 && arg1 > arg3.
-categories: [functions]
+categories: []
keywords: []
-menu:
- docs:
- parent: functions
-function:
+action:
aliases: [gt]
+ related:
+ - functions/compare/Eq
+ - functions/compare/Ge
+ - functions/compare/Le
+ - functions/compare/Lt
+ - functions/compare/Ne
returnType: bool
signatures: ['compare.Gt ARG1 ARG2 [ARG...]']
-relatedFunctions:
- - compare.Eq
- - compare.Ge
- - compare.Gt
- - compare.Le
- - compare.Lt
- - compare.Ne
aliases: [/functions/gt]
---
diff --git a/docs/content/en/functions/compare/Le.md b/docs/content/en/functions/compare/Le.md
index 792ea6ce6..319d376f6 100644
--- a/docs/content/en/functions/compare/Le.md
+++ b/docs/content/en/functions/compare/Le.md
@@ -1,23 +1,18 @@
---
title: compare.Le
-linkTitle: le
description: Returns the boolean truth of arg1 <= arg2 && arg1 <= arg3.
-categories: [functions]
+categories: []
keywords: []
-menu:
- docs:
- parent: functions
-function:
+action:
aliases: [le]
+ related:
+ - functions/compare/Eq
+ - functions/compare/Ge
+ - functions/compare/Gt
+ - functions/compare/Lt
+ - functions/compare/Ne
returnType: bool
signatures: ['compare.Le ARG1 ARG2 [ARG...]']
-relatedFunctions:
- - compare.Eq
- - compare.Ge
- - compare.Gt
- - compare.Le
- - compare.Lt
- - compare.Ne
aliases: [/functions/le]
---
diff --git a/docs/content/en/functions/compare/Lt.md b/docs/content/en/functions/compare/Lt.md
index 537c23b6f..3fe8f1d2c 100644
--- a/docs/content/en/functions/compare/Lt.md
+++ b/docs/content/en/functions/compare/Lt.md
@@ -1,23 +1,18 @@
---
title: compare.Lt
-linkTitle: lt
description: Returns the boolean truth of arg1 < arg2 && arg1 < arg3.
-categories: [functions]
+categories: []
keywords: []
-menu:
- docs:
- parent: functions
-function:
+action:
aliases: [lt]
+ related:
+ - functions/compare/Eq
+ - functions/compare/Ge
+ - functions/compare/Gt
+ - functions/compare/Le
+ - functions/compare/Ne
returnType: bool
signatures: ['compare.Lt ARG1 ARG2 [ARG...]']
-relatedFunctions:
- - compare.Eq
- - compare.Ge
- - compare.Gt
- - compare.Le
- - compare.Lt
- - compare.Ne
aliases: [/functions/lt]
---
diff --git a/docs/content/en/functions/compare/Ne.md b/docs/content/en/functions/compare/Ne.md
index 412f43d49..2d9f826fc 100644
--- a/docs/content/en/functions/compare/Ne.md
+++ b/docs/content/en/functions/compare/Ne.md
@@ -1,23 +1,18 @@
---
title: compare.Ne
-linkTitle: ne
description: Returns the boolean truth of arg1 != arg2 && arg1 != arg3.
-categories: [functions]
+categories: []
keywords: []
-menu:
- docs:
- parent: functions
-function:
+action:
aliases: [ne]
+ related:
+ - functions/compare/Eq
+ - functions/compare/Ge
+ - functions/compare/Gt
+ - functions/compare/Le
+ - functions/compare/Lt
returnType: bool
signatures: ['compare.Ne ARG1 ARG2 [ARG...]']
-relatedFunctions:
- - compare.Eq
- - compare.Ge
- - compare.Gt
- - compare.Le
- - compare.Lt
- - compare.Ne
aliases: [/functions/ne]
---
diff --git a/docs/content/en/functions/compare/_index.md b/docs/content/en/functions/compare/_index.md
new file mode 100644
index 000000000..a9b3a7b27
--- /dev/null
+++ b/docs/content/en/functions/compare/_index.md
@@ -0,0 +1,12 @@
+---
+title: Compare functions
+linkTitle: compare
+description: Template functions to compare two or more values.
+categories: []
+keywords: []
+menu:
+ docs:
+ parent: functions
+---
+
+Use these functions to compare two or more values.