From 3f2b8587b105830353c152baed964c29b6e0a073 Mon Sep 17 00:00:00 2001 From: Jeremiah Snapp <jeremiah@chef.io> Date: Fri, 5 Jun 2020 13:17:18 -0400 Subject: [PATCH] Replace regexreplace docs typo with regex_replace Signed-off-by: Jeremiah Snapp <jeremiah@chef.io> --- website/data/docs-navigation.js | 2 +- .../{regexreplace.mdx => regex_replace.mdx} | 20 +++++++++---------- .../from-1.5/functions/string/replace.mdx | 2 +- 3 files changed, 12 insertions(+), 12 deletions(-) rename website/pages/docs/from-1.5/functions/string/{regexreplace.mdx => regex_replace.mdx} (62%) diff --git a/website/data/docs-navigation.js b/website/data/docs-navigation.js index a4966c7f9..5afb3d00a 100644 --- a/website/data/docs-navigation.js +++ b/website/data/docs-navigation.js @@ -50,7 +50,7 @@ export default [ 'join', 'lower', 'replace', - 'regexreplace', + 'regex_replace', 'split', 'strrev', 'substr', diff --git a/website/pages/docs/from-1.5/functions/string/regexreplace.mdx b/website/pages/docs/from-1.5/functions/string/regex_replace.mdx similarity index 62% rename from website/pages/docs/from-1.5/functions/string/regexreplace.mdx rename to website/pages/docs/from-1.5/functions/string/regex_replace.mdx index 8957a4913..7d209a287 100644 --- a/website/pages/docs/from-1.5/functions/string/regexreplace.mdx +++ b/website/pages/docs/from-1.5/functions/string/regex_replace.mdx @@ -1,21 +1,21 @@ --- layout: docs -page_title: regexreplace - Functions - Configuration Language -sidebar_title: regexreplace +page_title: regex_replace - Functions - Configuration Language +sidebar_title: regex_replace description: |- - The regexreplace function searches a given string for another given substring, + The regex_replace function searches a given string for another given substring, and replaces all occurrences with a given replacement string. The substring argument can be a valid regular expression or a string. --- -# `regexreplace` Function +# `regex_replace` Function -`regexreplace` searches a given string for another given substring, and +`regex_replace` searches a given string for another given substring, and replaces each occurrence with a given replacement string. The substring argument can be a valid regular expression or a string. ```hcl -regexreplace(string, substring, replacement) +regex_replace(string, substring, replacement) ``` `substring` should not be wrapped in forward slashes, it is always treated as a @@ -26,17 +26,17 @@ name of a capture group. ## Examples ```shell-session -> regexreplace("hello world", "world", "everybody") +> regex_replace("hello world", "world", "everybody") hello everybody -> regexreplace("hello world", "w.*d", "everybody") +> regex_replace("hello world", "w.*d", "everybody") hello everybody -> regexreplace("-ab-axxb-", "a(x*)b", "$1W) +> regex_replace("-ab-axxb-", "a(x*)b", "$1W) --- -> regexreplace("-ab-axxb-", "a(x*)b", "${1}W") +> regex_replace("-ab-axxb-", "a(x*)b", "${1}W") -W-xxW- ``` diff --git a/website/pages/docs/from-1.5/functions/string/replace.mdx b/website/pages/docs/from-1.5/functions/string/replace.mdx index 54a9ed212..472f55da4 100644 --- a/website/pages/docs/from-1.5/functions/string/replace.mdx +++ b/website/pages/docs/from-1.5/functions/string/replace.mdx @@ -28,5 +28,5 @@ hello everybody ## Related Functions -- [`regexreplace`](/docs/from-1.5/functions/string/regexreplace) searches a given string for another given substring, +- [`regex_replace`](/docs/from-1.5/functions/string/regex_replace) searches a given string for another given substring, and replaces each occurrence with a given replacement string.