diff options
| author | anakinsleftleg <77084568+anakinsleftleg@users.noreply.github.com> | 2022-11-07 08:25:53 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-11-07 08:25:53 +0300 |
| commit | be87dba80df0ccd826ddb4539a186adef94c9d24 (patch) | |
| tree | 26fb229a411f69f2f7ee48b57b5ce81d515aeb6b | |
| parent | a079193f1918e7894cce84165ac70e054bc5cf7a (diff) | |
Clarify split function docs (#1792)
* Clarify split function docs
* Apply suggestions from code review
* Apply suggestions from code review
Co-authored-by: Joe Mooring <joe@mooring.com>
| -rw-r--r-- | content/en/functions/split.md | 8 |
1 files 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 %}} |