From 38d034df38b385d50160071f794cf3331b5cda24 Mon Sep 17 00:00:00 2001 From: digitalcraftsman Date: Mon, 29 Aug 2016 12:22:37 +0200 Subject: [PATCH] docs: Document shuffle template func Fixes #2393. --- docs/content/templates/functions.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) 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) }} + + +{{ shuffle (slice "foo" "bar" "buzz") }} + +``` + ### 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.