feat: add documentation for functions in index and util files #65
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Delta456
reviewed
Oct 21, 2024
There was a problem hiding this comment.
Hi @vickywane! Thanks for opening PR. We appreciate your contribution. I have a few points which will make your PR even better
- Do not elaborate too much on private functions
- Functions documentation in general should be short and easy to understand
- Examples are not needed for private functions.
|
Hi @Delta456 Thank you for the comment on this. I will adjust my changes and request another review. |
|
Hi @Delta456 I've reduced the elaborations on the function documentations and removed the examples for the private functions within the Looking forward to your next feedback. |
|
You're welcome @harsha509 @Delta456 . Looking forward to the merge 🫡! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The aim of this PR is to create function documentation using the JsDocs format for functions in the index and utils files.
This PR will close #56