Did some language clean up / clarification on JSON.MERGE documentaiton page.
#1065
+8
−8
Conversation
This file contains 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
|
|
Codecov ReportPatch and project coverage have no change.
Additional details and impacted files@@ Coverage Diff @@
## master #1065 +/- ##
=======================================
Coverage 79.18% 79.18%
=======================================
Files 15 15
Lines 3853 3853
=======================================
Hits 3051 3051
Misses 802 802 ☔ View full report in Codecov by Sentry. |
LiorKogan
reviewed
Aug 1, 2023
docs/commands/json.merge.md
Outdated
|
|
||
| [Examples](#examples) | ||
|
|
||
| ## Required arguments | ||
|
|
||
| <details open><summary><code>key</code></summary> | ||
|
|
||
| is key to merge into. | ||
| is the key to merge into. |
There was a problem hiding this comment.
This is what Nermina called "telegraphic writing style". She introduced this style in all module commands that she touched.
There was a problem hiding this comment.
Strange as it makes it sound like broken English also something being "key" in this sense means important. "is key to our understanding etc." Let's run without the "the" but this style is detrimental IMHO.
LiorKogan
reviewed
Aug 1, 2023
docs/commands/json.merge.md
Outdated
| </details> | ||
|
|
||
| <details open><summary><code>path</code></summary> | ||
|
|
||
| is JSONPath to specify. For non-existing keys the `path` must be `$`. For existing keys, for each matched `path`, the value that matches the `path` is being merged with the JSON `value`. For existing keys, when the path exists, except for the last element, a new child is added with the JSON `value`. | ||
| is the JSONPath to specify where in the JSON document to apply the merge. For non-existing keys the `path` must be `$`. For existing keys, for each matched `path`, the value that matches the `path` is merged with the JSON `value`. For existing keys, when the path exists, except for the last element, a new child is added with the JSON `value`. |
LiorKogan
reviewed
Aug 1, 2023
|
|
||
| </details> | ||
|
|
||
| <details open><summary><code>value</code></summary> | ||
|
|
||
| is JSON value to merge with at the specified path. Merging is done according to the following rules per JSON value in the `value` argument while considering the corresponding original value if it exists: | ||
| is the JSON value to merge with at the specified path. Merging is done according to the following rules per JSON value in the `value` argument while considering the corresponding original value if it exists: |
LiorKogan
reviewed
Aug 1, 2023
| </details> | ||
|
|
||
| ## Return value | ||
|
|
||
| JSET.MERGE returns a simple string reply: `OK` if executed correctly or `error` if fails to set the new values | ||
| JSET.MERGE returns a simple string reply: `OK` if executed correctly or `error` if fails to set the new values. |
Removed a couple of instances of "the" to stick with the style.
LiorKogan
approved these changes
Aug 1, 2023
LiorKogan
approved these changes
Aug 3, 2023
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.
No description provided.