summaryrefslogtreecommitdiff
path: root/docs/src/reference
diff options
context:
space:
mode:
Diffstat (limited to 'docs/src/reference')
-rw-r--r--docs/src/reference/types.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/src/reference/types.md b/docs/src/reference/types.md
index 9448feed..d6218029 100644
--- a/docs/src/reference/types.md
+++ b/docs/src/reference/types.md
@@ -362,7 +362,7 @@ string and returns the resulting string.
- pattern: string or regex (positional, required)
The pattern to search for.
- replacement: string or function (positional, required)
- The string to replace the matches with or a function that is passed a match dictionary if a regex was used.
+ The string to replace the matches with or a function that gets a dictionary for each match and can return individual replacement strings.
- count: integer (named)
If given, only the first `count` matches of the pattern are placed.
- returns: string