This is an automated email from the ASF dual-hosted git repository.
spmallette 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 d74684fb4e Add a note on key()-step input to the reference docs
d74684fb4e is described below
commit d74684fb4ea109ba59865c250e26c198d254ca94
Author: Stephen Mallette <[email protected]>
AuthorDate: Thu Sep 10 00:09:13 2026 +0000
Add a note on key()-step input to the reference docs
Clarify in the key()-step reference section that the step operates on a
Property and must therefore follow a Property-emitting step such as
properties(). Applying key() directly to a vertex or edge raises an error.
Assisted-by: Kiro:claude-opus-4.8
---
docs/src/reference/the-traversal.asciidoc | 3 +++
1 file changed, 3 insertions(+)
diff --git a/docs/src/reference/the-traversal.asciidoc
b/docs/src/reference/the-traversal.asciidoc
index d3db90f302..57a32ba02b 100644
--- a/docs/src/reference/the-traversal.asciidoc
+++ b/docs/src/reference/the-traversal.asciidoc
@@ -2946,6 +2946,9 @@ g.V(1).properties().key()
g.V(1).properties().properties().key()
----
+NOTE: Because `key()` operates on a `Property`, it must be preceded by a
`Property`-emitting step such as
+<<properties-step,`properties()`>>. Applying `key()` directly to a `Vertex` or
`Edge` raises an error.
+
*Additional References*
link:++https://tinkerpop.apache.org/javadocs/x.y.z/core/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.html#key()++[`key()`]
