diff options
author | digitalcraftsman <digitalcraftsman@protonmail.com> | 2016-08-29 13:22:37 +0300 |
---|---|---|
committer | digitalcraftsman <digitalcraftsman@protonmail.com> | 2016-08-29 13:22:37 +0300 |
commit | 38d034df38b385d50160071f794cf3331b5cda24 (patch) | |
tree | 875d0b84576bd53ec37e5c626d5b878685b7cb81 /docs | |
parent | 6eff9e501534dfa952b059f446faf9eff097aef7 (diff) |
docs: Document shuffle template func
Fixes #2393.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/content/templates/functions.md | 14 |
1 files changed, 13 insertions, 1 deletions
diff --git a/docs/content/templates/functions.md b/docs/content/templates/functions.md index 1df0a80f8..cd212b85d 100644 --- a/docs/content/templates/functions.md +++ b/docs/content/templates/functions.md @@ -97,6 +97,18 @@ One use case is the concatenation of elements in combination with `delimit`: ``` +### shuffle + +`shuffle` returns a random permutation of a given array or slice, e.g. + +```html +{{ shuffle (seq 1 5) }} +<!-- returns [2 5 3 1 4] --> + +{{ shuffle (slice "foo" "bar" "buzz") }} +<!-- returns [buzz foo bar] --> +``` + ### echoParam Prints a parameter if it is set. @@ -128,7 +140,7 @@ Encodes a given object to JSON. e.g. - {{ dict "title" .Title "content" .Plain | jsonify }} + {{ dict "title" .Title "content" .Plain | jsonify }} ### last Slices an array to only the last _N_ elements. |