Audit and make documentation for command JSON.CLEAR consistent #772 #887
Conversation
There was a problem hiding this comment.
Hi @nm123github , Most of the changes look good. However, would it be possible to modify example section of this document with bash code block as per below:
Examples: List all possible examples of the command and the expected output. Assume CLI implementation
the CLI prompt should be 127.0.0.1:7379> and not anything else
For reference, please check out the https://dicedb.io/commands/jsonget/#example-usage example section. Note that the overall documentation of json.get is yet to be revamped but the format of the examples is standardized. Additionally for other sections you can refer to the SET command docs.
Thanks.
| @@ -5,114 +5,91 @@ description: Documentation for the DiceDB command JSON.CLEAR | |||
|
|
|||
| The `JSON.CLEAR` command is part of the DiceDBJSON module, which allows you to manipulate JSON data stored in DiceDB. This command is used to clear the value at a specified path in a JSON document, effectively setting it to an empty state. This can be particularly useful when you want to reset a part of your JSON document without removing the key itself. | |||
There was a problem hiding this comment.
Hi, as per recent discussion on DiceDb community, DiceDB supports JSON natively hence its not a part of DiceDBJSON module. Would it be okay to update the description accordingly.
There was a problem hiding this comment.
Hey @apoorvyadav1111, changed to remove part of the DiceDBJSON module
Summary of Changes
Audit documentation for JSON.CLEAR and make it consistent with the existing implementation.
#772
Changes Made
## Behavioursection which i changed.## Errorssection.