Clarify subgraph-step TinkerVertex caveat as implementation-dependent#3571
Open
spmallette wants to merge 1 commit into
Open
Clarify subgraph-step TinkerVertex caveat as implementation-dependent#3571spmallette wants to merge 1 commit into
spmallette wants to merge 1 commit into
Conversation
The subgraph-step section warned that a TinkerGraph subgraph's elements could not be used directly against the original graph and gave an example it said would likely return an error. That is misleading for the example shown, where the original graph is also a TinkerGraph: TinkerGraph looks vertices up by their identifier, so the reference resolves and the traversal succeeds. Reword the caveat and its callout to frame the behavior as implementation-dependent. It resolves for a TinkerGraph original and may fail against a different implementation that does not recognize a foreign TinkerVertex. The ReferenceVertex/id() block remains the portable recommendation. 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 #3571 +/- ##
============================================
+ Coverage 76.35% 76.52% +0.16%
- Complexity 13424 14309 +885
============================================
Files 1012 1036 +24
Lines 60341 64608 +4267
Branches 7075 7661 +586
============================================
+ Hits 46076 49442 +3366
- Misses 11548 12078 +530
- Partials 2717 3088 +371 ☔ 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
subgraph()-step section cautions that a TinkerGraph subgraph's elements (TinkerVertex/TinkerEdge) can not be used directly in Gremlin running against the original graph, and presents this example as one that "would likely return an error":For the example as shown, though, the original graph is also a TinkerGraph. In that case TinkerGraph looks vertices up by their identifier, so the reference resolves and
g.V(v).out()returns the expected result rather than erroring. The warning is accurate only when the original graph is a different implementation that may not recognize a foreignTinkerVertex.This reduces the caveat paragraph and its callout to implementation-dependent framing:
TinkerVertexand could return an error.Scope is limited to the caveat paragraph and its second callout. The edge-induced subgraph examples above and the
ReferenceVertex/id()portable-recommendation block below are unchanged, and the illustrative snippet remains non-executed text. The reference book was rendered locally to confirm it builds and reads coherently.