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

Add documentation for command ZRANGE #1284

Open
apoorvyadav1111 opened this issue Nov 14, 2024 · 4 comments
Open

Add documentation for command ZRANGE #1284

apoorvyadav1111 opened this issue Nov 14, 2024 · 4 comments
Assignees
Labels
difficulty-level -- easy documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@apoorvyadav1111
Copy link
Contributor

The documentation of the command ZRANGE is absent in the docs. 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:

Go through the documentation of the command and run all the examples, making sure they all work as expected
If the same command is present in Redis, then the expected output of the DiceDB command is the same as the Redis output
If the command is not in Redis, then as per your judgment, raise an issue with this template or fix the documentation and raise a pull request.
The documentation should contain the following sections in the following order
short and concise introduction paragraph about the command covering what it does
Syntax
Parameters: List all the parameters the command accepts, and ignore the section if there are no parameters
Return values: List all possible return values and under what condition
Behaviour: Describe the behavior of the command, what it does, how it does it, some internal specifics if any
Errors: List all possible errors the command can throw and under what condition
Examples: List all possible examples of the command and the expected output. Assume CLI implementation
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

to understand all possible return values
to understand all possible error values and conditions
to understand different parameters the command accepts
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

if you see any "Conclusion" section, remove it
the headers (h1, h2, h3) should be appropriately used
the CLI prompt should be 127.0.0.1:7379> and not anything else
Use markdown tables for parameters and return values (ref SET command documentation)
wrap any command or paramter in backticks (`) to highlight them
the section header should be capitalize as used in the SET command documentation
If 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.

Please refer to the following files for sample structure:

docs/command_docs_template.md
docs/sample_command_docs.md
@apoorvyadav1111 apoorvyadav1111 added documentation Improvements or additions to documentation good first issue Good for newcomers difficulty-level -- easy labels Nov 14, 2024
@gauravrp
Copy link

Hey @apoorvyadav1111 can you please assign me this issue?

@apoorvyadav1111
Copy link
Contributor Author

Assigned @gauravrp 🚀

@jonathanalvares9009
Copy link

Hi @apoorvyadav1111 , I'm interested in picking up this issue.

@lucifercr07
Copy link
Contributor

Since there hasn't been any activity on ticket, assigning it to @jonathanalvares9009.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
difficulty-level -- easy documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

4 participants