-
Notifications
You must be signed in to change notification settings - Fork 18
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 missing natspec comments on Smart Contracts functions #217
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
…lticall-multicontract
… need fixing for running solidity coverage
…ulticall-multicontract
…icall-multicontract
…natspec-comments
Codecov Report
@@ Coverage Diff @@
## main #217 +/- ##
==========================================
- Coverage 53.39% 51.69% -1.71%
==========================================
Files 343 283 -60
Lines 43527 41182 -2345
Branches 369 0 -369
==========================================
- Hits 23240 21287 -1953
+ Misses 17874 17478 -396
- Partials 2413 2417 +4 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
…icenet into add-natspec-comments
vtleonardo
requested changes
Aug 30, 2022
Co-authored-by: Leonardo Viana <38760502+vtleonardo@users.noreply.github.com>
Co-authored-by: Leonardo Viana <38760502+vtleonardo@users.noreply.github.com>
Co-authored-by: Leonardo Viana <38760502+vtleonardo@users.noreply.github.com>
Co-authored-by: Leonardo Viana <38760502+vtleonardo@users.noreply.github.com>
…natspec-comments
vtleonardo
approved these changes
Sep 7, 2022
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
This pull request was closed.
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.
Scope
This PR adds missing comments on the functions of the following contracts:
1- ATokenBurner
2- ATokenMinter
6- Foundation
7- Proxy
8- Snapshot
9- StakingDescriptor
Also minor changes to parameter names to better reflect their specific functionality.
Why?
To have better knowledge of contracts functionality