From be87dba80df0ccd826ddb4539a186adef94c9d24 Mon Sep 17 00:00:00 2001 From: anakinsleftleg <77084568+anakinsleftleg@users.noreply.github.com> Date: Mon, 7 Nov 2022 00:25:53 -0500 Subject: [PATCH] Clarify split function docs (#1792) * Clarify split function docs * Apply suggestions from code review * Apply suggestions from code review Co-authored-by: Joe Mooring --- content/en/functions/split.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/content/en/functions/split.md b/content/en/functions/split.md index a66a7cf0c..44cab8e6e 100644 --- a/content/en/functions/split.md +++ b/content/en/functions/split.md @@ -1,7 +1,7 @@ --- title: split # linktitle: split -description: splits a string into substrings separated by a delimiter +description: Returns an array of strings by splitting STRING by DELIM. date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 @@ -18,4 +18,8 @@ deprecated: false aliases: [] --- -* `{{split "tag1,tag2,tag3" "," }}` → ["tag1" "tag2" "tag3"] +* `{{ split "tag1,tag2,tag3" "," }}` → ["tag1", "tag2", "tag3"] + +{{% note %}} +`split` essentially does the opposite of [delimit]({{< ref "functions/delimit" >}}). While `split` creates a slice from a string, `delimit` creates a string from a slice. +{{% /note %}}