DiceDB / dice

DiceDB is a redis-compliant, in-memory, real-time, and reactive database optimized for modern hardware and for building and scaling truly real-time applications.
https://dicedb.io/
Other
6.02k stars 947 forks source link

Audit and make documentation for command `OBJECT` consistent #834

Open arpitbbhayani opened 1 week ago

arpitbbhayani commented 1 week ago

The documentation of the command [OBJECT](https://dicedb.io/commands/object/) 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:

  1. Go through the documentation of the command and run all the examples, making sure they all work as expected
  2. If the same command is present in Redis, then the expected output of the DiceDB command is the same as the Redis output
  3. 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.
  4. 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

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

sashpawar11 commented 1 week ago

Hi @arpitbbhayani - please assign this to me. Thankyou.

lucifercr07 commented 1 week ago

@sashpawar11 assigned, thanks for contributing.

sashpawar11 commented 1 week ago

Raised issue #934 , encountered while testing OBJECT command

arpitbbhayani commented 2 days ago

Hello @sashpawar11,

There has been no activity on this issue for the past 5 days. It would be awesome if you keep posting updates to this issue so that we know you are actively working on it.

We are really eager to close this issue at the earliest, hence if we continue to see the inactivity, we will have to reassign the issue to someone else. We are doing this to ensure that the project maintains its momentum and others are not blocked on this work.

Just drop a comment with the current status of the work or share any issues you are facing. We can always chip in to help you out.

Thanks again.

sashpawar11 commented 2 days ago

Hey @arpitbbhayani - there were subcommands in the OBJECT docs that were missing support in dicedb. It is currently being worked on as mentioned in the linked issue of this ticket.

Please advise if we can wait on auditing this doc until the necessary groundwork is in place, or if we should continue proceeding with the changes for this doc. I have the refactored changes ready, but was holding on due to the issue mentioned above.

Thankyou.