This is an automated email from the ASF dual-hosted git repository.
Cole-Greer pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/tinkerpop.git
The following commit(s) were added to refs/heads/master by this push:
new 157b213776 TINKERPOP-3233 Added escaped characters to docs (#3383)
157b213776 is described below
commit 157b2137769c77f4d043dea9ef979749b8ec4294
Author: Guian Gumpac <[email protected]>
AuthorDate: Wed Apr 22 10:35:56 2026 -0700
TINKERPOP-3233 Added escaped characters to docs (#3383)
---
docs/src/reference/gremlin-variants.asciidoc | 19 +++++++++++++++++++
1 file changed, 19 insertions(+)
diff --git a/docs/src/reference/gremlin-variants.asciidoc
b/docs/src/reference/gremlin-variants.asciidoc
index 40a6e66a35..32c4a64661 100644
--- a/docs/src/reference/gremlin-variants.asciidoc
+++ b/docs/src/reference/gremlin-variants.asciidoc
@@ -97,6 +97,25 @@ When documentation or code refers to a "gremlin-lang
string", "canonical Gremlin
traversal string that conforms to this ANTLR grammar. The `GremlinTranslator`
class can convert canonical Gremlin into
language-specific syntax for any supported GLV (see <<translators, Translating
Gremlin>>).
+==== String Escaping
+
+When serializing string values into canonical Gremlin, all GLVs escape the
following characters so that the resulting
+string is valid within the ANTLR grammar:
+
+[cols="1,1",options="header"]
+|===
+|Character |Escape Sequence
+|\ |\\
+|" |\"
+|newline |\n
+|carriage return |\r
+|tab |\t
+|backspace |\b
+|form feed |\f
+|===
+
+For example, a string value `say "hello"` would be serialized as `"say
\"hello\""` in the canonical Gremlin string.
+
The following sections describe each language variant and driver that is
officially TinkerPop a part of the project,
providing more detailed information about usage, configuration and known
limitations.
