Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#772: Audit and make documentation for command JSON.CLEAR consistent #887

Merged
merged 1 commit into from
Oct 4, 2024

Conversation

nm123github
Copy link
Contributor

@nm123github nm123github commented Oct 1, 2024

Summary of Changes

Audit documentation for JSON.CLEAR and make it consistent with the existing implementation.
#772

Changes Made

  • Attempted to follow documentation format in SET
  • Found some discrepancies in ## Behaviour section which i changed.
  • Fixed few things in the ## Errors section.

Copy link
Contributor

@apoorvyadav1111 apoorvyadav1111 left a comment

Choose a reason for hiding this comment

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

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.

Copy link
Contributor

@apoorvyadav1111 apoorvyadav1111 left a comment

Choose a reason for hiding this comment

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

Thanks for addressing my comments.

@JyotinderSingh
Copy link
Collaborator

Thanks for the contribution @nm123github! Thanks for the reviews @apoorvyadav1111.

@JyotinderSingh JyotinderSingh changed the title Audit and make documentation for command JSON.CLEAR consistent #772 #772: Audit and make documentation for command JSON.CLEAR consistent Oct 4, 2024
@JyotinderSingh JyotinderSingh merged commit 1953a10 into DiceDB:master Oct 4, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants