DiceDB
Audit and make documentation for command `BFINIT` consistent
The documentation of the command [BFINIT](https://dicedb.io/commands/bfinit/) 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:
- 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.
2-Day Update:
I’ve set up the project locally and have been reviewing the code in-depth. I now have a solid understanding of the project structure, covering both the documentation and Golang implementations. However, I’ll need a bit more time to fully grasp all aspects of the code.
At present, I’m testing the commands located in /docs/src/content/docs/commands/BFINIT.md and checking for any inconsistencies. Once I complete that, I should be fully ready to move forward.
Also I was trying this command
I was getting this error does this mean that the docs of this is outdated and I need to fix the docs to make it upto date to current version?
localhost:7379> BFINIT my_bloom_filter error_rate 0.005 initial_capacity 5000
(error) ERROR wrong number of arguments for 'bfinit' command
Hello @souvik150,
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.
Hello @souvik150,
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.
