Fix incorrect step name in PropertyMap reference docs#3569
Closed
spmallette wants to merge 1 commit into
Closed
Conversation
The prose in the PropertyMap section referred to the step as propertiesMap(), but the actual step is propertyMap(). The wrong name is especially misleading in Groovy, where propertiesMap() does not error and instead silently returns empty results, so a reader copying the prose name gets no output and no clue why. Correct the prose to propertyMap() to match the executable examples in the same section. Assisted-by: Kiro:claude-opus-4.8
Contributor
Author
|
merged with 1404d52 |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #3569 +/- ##
============================================
+ Coverage 76.35% 76.46% +0.10%
- Complexity 13424 14293 +869
============================================
Files 1012 1036 +24
Lines 60341 64608 +4267
Branches 7075 7661 +586
============================================
+ Hits 46076 49402 +3326
- Misses 11548 12114 +566
- Partials 2717 3092 +375 ☔ 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
2 participants
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 prose in the PropertyMap section of
docs/src/reference/the-traversal.asciidocreferred to the step aspropertiesMap(), but the actual step ispropertyMap()(no "s"). The section's executable examples already use the correctpropertyMap(), so only the prose was wrong.This is worth correcting because the wrong name fails silently rather than loudly. In Groovy,
propertiesMap()does not raise an error; it resolves to a lookup for a property key that does not exist and returns empty results. A newcomer copying the name from the prose therefore gets empty output with no error and no indication of what went wrong.The fix changes a single line of prose to
propertyMap()so it matches the runnable examples directly below it. The examples remain the standard executable[gremlin-groovy,modern]blocks, so their output is rendered at build time (including the empty==>[]maps for vertices without the requested property, which illustrates the behavior clearly).