📝 Add Natspec comments for clarity #146
Merged
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
Aboudjem
requested review from
filmakarov,
ankurdubey521,
AmanRaj1608 and
livingrockrises
SMA-98 Natspec Comments for All Functions
Ensure all functions have Natspec comments for better documentation and understanding. |
🙈 Remove ignore linting rules
| @@ -51,7 +51,6 @@ | |||
| "@typescript-eslint/eslint-plugin": "^5.30.5", | |||
| "@typescript-eslint/parser": "^5.30.5", | |||
| "chai": "^4.3.7", | |||
| "dotenv": "^16.0.1", | |||
There was a problem hiding this comment.
why did we remove dotenv?
There was a problem hiding this comment.
I didn't remove it, it was duplicated on devdep
ankurdubey521
approved these changes
Oct 16, 2023
|
Thanks a lot for this @Aboudjem ! |
livingrockrises
approved these changes
Oct 16, 2023
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.
Summary
Added NATSPEC comments to missing functions and updated the existing ones that were incomplete
Related Issue: #SMA-98
Change Type