docs: Update replace func
authorCameron Moore <moorereason@gmail.com>
Mon, 7 Sep 2020 20:29:20 +0000 (15:29 -0500)
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Mon, 7 Sep 2020 20:45:14 +0000 (22:45 +0200)
Updates for #7602

docs/content/en/functions/replace.md

index aeb19f296247405a23981b3c113d83b1a0d5568d..f1f43d11294f8bb34fa86a2c04aa484bfffeebcf 100644 (file)
@@ -1,17 +1,16 @@
 ---
 title: replace
-# linktitle: replace
 description: Replaces all occurrences of the search string with the replacement string.
 godocref:
 date: 2017-02-01
 publishdate: 2017-02-01
-lastmod: 2017-02-01
+lastmod: 2020-09-07
 categories: [functions]
 menu:
   docs:
     parent: "functions"
 keywords: []
-signature: ["replace INPUT OLD NEW"]
+signature: ["strings.Replace INPUT OLD NEW [LIMIT]", "replace INPUT OLD NEW [LIMIT]"]
 workson: []
 hugoversion:
 relatedfuncs: []
@@ -19,8 +18,13 @@ deprecated: false
 aliases: []
 ---
 
+Replace returns a copy of `INPUT` with all occurrences of `OLD` replaced with `NEW`.
+The number of replacements can be limited with an optional `LIMIT` parameter.
+
 ```
 `{{ replace "Batman and Robin" "Robin" "Catwoman" }}`
 → "Batman and Catwoman"
+
+{{ replace "aabbaabb" "a" "z" 2 }} → "zzbbaabb"
 ```