N-05 Missing Docstrings #1925
Merged
N-05 Missing Docstrings #1925
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
sparrowDom
requested review from
DanielVF,
naddison36 and
shahthepro
as code owners
rafaelugolini
temporarily deployed
to
preview-ousd-sparrowdom-01xf47
sparrowDom
merged commit e2934e4
into
sparrowDom/balancer-composable-st-pool
8 of 14 checks passed
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.
Audit notes:
Several parts of the codebase either have no documentation, or the documentation is not in NatSpec format:
In the BalancerMetaPoolStrategy contract, lines 28 and 34
In the BaseBalancerStrategy contract, lines 27, 29, 44, 46, 48, 51, and 57
Consider ensuring that all the above instances of code have the proper documentation written in NatSpec format. This would ensure that tools like Etherscan can accurately render these comments.