Recommend not escaping all the things (#793)

eemeli · web-flow · commit 1de49c89a82e · 2024-05-20T10:01:58.000-07:00
* Recommend not escaping all the things

* Update spec/syntax.md
diff --git a/spec/syntax.md b/spec/syntax.md
@@ -943,6 +943,16 @@ escaped-char = backslash ( backslash / "{" / "|" / "}" )
 backslash    = %x5C ; U+005C REVERSE SOLIDUS "\"
 ```
 
+> [!NOTE]
+> The `escaped-char` rule allows escaping some characters in places where
+> they do not need to be escaped, such as braces in a _quoted_ _literal_.
+> For example, `|foo {bar}|` and `|foo \{bar\}|` are synonymous.
+
+When writing or generating a _message_, escape sequences SHOULD NOT be used
+unless required by the syntax.
+That is, inside _literals_ only escape `|` 
+and inside _patterns_ only escape `{` and `}`.
+
 ### Whitespace
 
 **_<dfn>Whitespace</dfn>_** is defined as one or more of
