shithub: hugo

Download patch

ref: f7c1b5fe1c22ba5f16e3fa442df6a8a70711f23f
parent: 183e8626070a5f55c11648082e3060e35231d934
author: Cameron Moore <moorereason@gmail.com>
date: Mon Sep 7 11:29:55 EDT 2020

docs: Update replaceRE func

Updates for #7604

--- a/docs/content/en/functions/replacere.md
+++ b/docs/content/en/functions/replacere.md
@@ -1,17 +1,16 @@
 ---
 title: replaceRE
-# linktitle: replaceRE
 description: Replaces all occurrences of a regular expression with the replacement pattern.
 godocref:
 date: 2017-02-01
 publishdate: 2017-02-01
-lastmod: 2017-04-30
+lastmod: 2020-09-07
 categories: [functions]
 menu:
   docs:
     parent: "functions"
 keywords: [regex]
-signature: ["replaceRE PATTERN REPLACEMENT INPUT"]
+signature: ["strings.ReplaceRE PATTERN REPLACEMENT INPUT [LIMIT]", "replaceRE PATTERN REPLACEMENT INPUT [LIMIT]"]
 workson: []
 hugoversion:
 relatedfuncs: []
@@ -19,9 +18,14 @@
 aliases: []
 ---
 
+`strings.ReplaceRE` returns a copy of `INPUT`, replacing all matches of the regular
+expression `PATTERN` with the replacement text `REPLACEMENT`.
+The number of replacements can be limited with an optional `LIMIT` parameter.
+
 ```
 {{ replaceRE "^https?://([^/]+).*" "$1" "http://gohugo.io/docs" }}` → "gohugo.io"
 {{ "http://gohugo.io/docs" | replaceRE "^https?://([^/]+).*" "$1" }}` → "gohugo.io"
+{{ replaceRE "a+b" "X" "aabbaabbab" 1 }} → "Xbaabbab"
 ```
 
 {{% note %}}