Home Original page

Did some language clean up / clarification on `JSON.MERGE` documentaiton page. by simonprickett · Pull Request #1065 · RedisJSON/RedisJSON

@simonprickett

@CLAassistant

CLA assistant check
All committers have signed the CLA.

@codecov

Codecov Report

Patch and project coverage have no change.

Comparison is base (8e22335) 79.18% compared to head (fbb54ac) 79.18%.

❗ Current head fbb54ac differs from pull request most recent head 734d060. Consider uploading reports for the commit 734d060 to get more accurate results

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.
📢 Have feedback on the report? Share it here.

LiorKogan

<details open><summary><code>key</code></summary>

is key to merge into.
is the key to merge into.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is what Nermina called "telegraphic writing style". She introduced this style in all module commands that she touched.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

<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`.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just remove the "the"

LiorKogan

<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:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same

LiorKogan

## 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.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

JSON.MERGE ;-)

Removed a couple of instances of "the" to stick with the style.

LiorKogan

LiorKogan