-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Audit and make documentation for command GET
consistent
#844
Comments
Hi @arpitbbhayani would love to pick this one as my first issue. |
@arpitbbhayani Will start working on it today |
Assigned. |
@arpitbbhayani @JyotinderSingh |
I have made a PR keeping the Additional Notes. |
@sebzz2k2 assigned, thanks for contributing. |
Co-authored-by: Jyotinder Singh <[email protected]>
@lucifercr07 is this still open? as i see some PRs Already merged |
Closing, merged as part of #875 |
The documentation of the command
[GET](https://dicedb.io/commands/get/)
present in the docs could have become stale. We need your help to ensure that the documentation is complete, correct, and consistent. Completing this issue will give you much-needed exposure to how the command is implemented and the different parameters it accepts. Hence, this is a great way to build a good understanding of the project and its functionality. While still making a significant contribution. Here's what you need to do:Note: The title of the sections should be the exact strings mentioned above, like "Examples", "Return values", etc.
Note: The description of the command in Frontmatter of the command.md file is the first paragraph (introduction) of the command.
Go through the DiceDB/dice repository and explore the command implementation
Please use the documentation of the SET command as the reference point and structure the
documentation of this command in a very similar way, including the following points
127.0.0.1:7379>
and not anything elseIf you find any inconsistencies, please fix the documentation and raise the PR.
The core idea of this exercise is to ensure that the documentation is consistent, correct, and complete.
Make sure you comment on the other issues you created (if any) as a comment on this issue and also any PR (if any) that you created.
Thank you for picking this up and contributing to the DiceDB. It means a ton.
The text was updated successfully, but these errors were encountered: