summaryrefslogtreecommitdiffstats
path: root/docs/content/en/functions/_common/regular-expressions.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/content/en/functions/_common/regular-expressions.md')
-rw-r--r--docs/content/en/functions/_common/regular-expressions.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/content/en/functions/_common/regular-expressions.md b/docs/content/en/functions/_common/regular-expressions.md
new file mode 100644
index 000000000..9da340849
--- /dev/null
+++ b/docs/content/en/functions/_common/regular-expressions.md
@@ -0,0 +1,8 @@
+When specifying the regular expression, use a raw [string literal] (backticks) instead of an interpreted string literal (double quotes) to simplify the syntax. With an interpreted string literal you must escape backslashes.
+
+Go's regular expression package implements the [RE2 syntax]. The RE2 syntax is a subset of that accepted by [PCRE], roughly speaking, and with various [caveats]. Note that the RE2 `\C` escape sequence is not supported.
+
+[caveats]: https://swtch.com/~rsc/regexp/regexp3.html#caveats
+[PCRE]: https://www.pcre.org/
+[RE2 syntax]: https://github.com/google/re2/wiki/Syntax/
+[string literal]: https://go.dev/ref/spec#String_literals