Clarify gremlin-javascript Limitations for Character/Duration and subgraph - #3557
Merged
spmallette merged 1 commit intoJul 23, 2026
Merged
Conversation
…graph Name the actual failure mode for unsupported Character and Duration values (the client throws a deserialization error on the unknown type code) and note that these types cannot currently be produced from the client. Reword the subgraph limitation to explain that passing the detached graph to traversal().with_() does not error immediately but yields a non-functional traversal source that fails on execution. Assisted-by: Kiro:claude-opus-4.8
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #3557 +/- ##
============================================
+ Coverage 76.35% 76.43% +0.07%
- Complexity 13424 14284 +860
============================================
Files 1012 1036 +24
Lines 60341 64561 +4220
Branches 7075 7656 +581
============================================
+ Hits 46076 49349 +3273
- Misses 11548 12122 +574
- Partials 2717 3090 +373 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The gremlin-javascript Limitations section in
docs/src/reference/gremlin-variants.asciidocstates two limitations correctly but leaves a reader unable to tell what actually happens when they are hit.This change makes two of those bullets precise:
CharacterandDurationvalues. The bullet now names the failure mode: if the server returns one of these types the client throws a deserialization error for the unknown type code, rather than failing silently or coercing the value. It also notes that these types cannot currently be produced from the client, since GremlinLang provides no literal syntax for them, so the failure is only observable against a server that emits them directly.subgraph()detached graph. The previous wording said the result "cannot be passed totraversal().with(...)", which is imprecise: passing it does not raise an error immediately. The bullet now explains that it yields a non-functional traversal source that fails only when a traversal is executed against it (surfacing as an opaquethis.connection.submit is not a function).No behavior changes. Docs-only precision fix, scoped to this section; other variant sections are untouched. The docs render cleanly.