Add expected output and explanatory callouts to values()-step docs#3570
Closed
spmallette wants to merge 1 commit into
Closed
Add expected output and explanatory callouts to values()-step docs#3570spmallette wants to merge 1 commit into
spmallette wants to merge 1 commit into
Conversation
The values()-step reference section listed three examples with no
rendered output and only a single sentence of prose, leaving the
behavior of the step hard to predict. Add an introductory explanation,
numbered callouts on each example, and a note that result order is not
guaranteed. The callouts clarify that a no-argument values() returns
every property value across all keys, that the sample vertex has a
multi-valued location property, and that properties('location').values()
extracts meta-property values (startTime/endTime) rather than the
city-name values returned by values('location'). The examples remain
executable so their output is rendered at build time.
Assisted-by: Kiro:claude-opus-4.8
Contributor
Author
|
merged on 45bd9c6 |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #3570 +/- ##
============================================
+ Coverage 76.35% 76.48% +0.12%
- Complexity 13424 14292 +868
============================================
Files 1012 1036 +24
Lines 60341 64608 +4267
Branches 7075 7661 +586
============================================
+ Hits 46076 49415 +3339
- Misses 11548 12099 +551
- Partials 2717 3094 +377 ☔ 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 reference documentation for the values()-step listed three examples against the TinkerPop Crew graph but rendered no output and offered only a single sentence of prose, so the behavior of the step was difficult to predict from the docs alone.
This adds:
The examples remain executable, so their output is rendered at build time rather than hand-written. No behavior changes; this is a documentation-only improvement.