docs: Update replace func

Updates for #7602
This commit is contained in:
Cameron Moore 2020-09-07 15:29:20 -05:00 committed by Bjørn Erik Pedersen
parent f50ee6bbe5
commit 183e862607

View file

@ -1,17 +1,16 @@
--- ---
title: replace title: replace
# linktitle: replace
description: Replaces all occurrences of the search string with the replacement string. description: Replaces all occurrences of the search string with the replacement string.
godocref: godocref:
date: 2017-02-01 date: 2017-02-01
publishdate: 2017-02-01 publishdate: 2017-02-01
lastmod: 2017-02-01 lastmod: 2020-09-07
categories: [functions] categories: [functions]
menu: menu:
docs: docs:
parent: "functions" parent: "functions"
keywords: [] keywords: []
signature: ["replace INPUT OLD NEW"] signature: ["strings.Replace INPUT OLD NEW [LIMIT]", "replace INPUT OLD NEW [LIMIT]"]
workson: [] workson: []
hugoversion: hugoversion:
relatedfuncs: [] relatedfuncs: []
@ -19,8 +18,13 @@ deprecated: false
aliases: [] 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" }}` `{{ replace "Batman and Robin" "Robin" "Catwoman" }}`
→ "Batman and Catwoman" → "Batman and Catwoman"
{{ replace "aabbaabb" "a" "z" 2 }} → "zzbbaabb"
``` ```