Add note about escaping backslash in pattern trait

smithy-lang · Feb 14, 2022 · e7a9528 · e7a9528
1 parent 9cb7f95
commit e7a9528
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/docs/source/1.0/spec/core/constraint-traits.rst b/docs/source/1.0/spec/core/constraint-traits.rst
@@ -427,6 +427,12 @@ languages.
     string matches the regular expression, whereas ``@pattern("^\\w+$")``
     requires that the entire string matches the regular expression.
 
+.. note::
+
+    Pattern values that contain ``\`` need to :ref:`escape it <string-escape-characters>`.
+    For example, the regular expression ``^\w+$`` would be specified as
+    ``@pattern("^\\w+$")``.
+
 .. tabs::
 
     .. code-tab:: smithy