From 1f08f7dba88babf865f2674fdcfba915ba23e11d Mon Sep 17 00:00:00 2001 From: Krista LaFentres Date: Fri, 22 Oct 2021 16:42:17 -0500 Subject: [PATCH] Clarify the way the trim() function works and add some more examples --- website/docs/language/functions/trim.html.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/website/docs/language/functions/trim.html.md b/website/docs/language/functions/trim.html.md index 43f12f2af..10a0aeb27 100644 --- a/website/docs/language/functions/trim.html.md +++ b/website/docs/language/functions/trim.html.md @@ -3,20 +3,33 @@ layout: "language" page_title: "trim - Functions - Configuration Language" sidebar_current: "docs-funcs-string-trim" description: |- - The trim function removes the specified characters from the start and end of + The trim function removes the specified set of characters from the start and end of a given string. --- # `trim` Function -`trim` removes the specified characters from the start and end of the given +`trim` removes the specified set of characters from the start and end of the given string. +```hcl +trim(string, str_character_set) +``` + +Every occurrence of a character in the second argument is removed from the start +and end of the string specified in the first argument. + ## Examples ``` > trim("?!hello?!", "!?") -hello +"hello" + +> trim("foobar", "far") +"oob" + +> trim(" hello! world.! ", "! ") +"hello! world." ``` ## Related Functions