-
Notifications
You must be signed in to change notification settings - Fork 75
fix[N04] Add additional documentation #102
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
Merged
Merged
Conversation
This file contains hidden or 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
Signed-off-by: chrismaree <christopher.maree@gmail.com>
mrice32
approved these changes
Mar 17, 2022
nicholaspai
reviewed
Mar 17, 2022
nicholaspai
reviewed
Mar 17, 2022
nicholaspai
reviewed
Mar 17, 2022
nicholaspai
reviewed
Mar 17, 2022
nicholaspai
approved these changes
Mar 17, 2022
Member
nicholaspai
left a comment
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 after committing my suggestions!
Co-authored-by: nicholaspai <9457025+nicholaspai@users.noreply.github.com>
Co-authored-by: nicholaspai <9457025+nicholaspai@users.noreply.github.com>
Co-authored-by: nicholaspai <9457025+nicholaspai@users.noreply.github.com>
Co-authored-by: nicholaspai <9457025+nicholaspai@users.noreply.github.com>
This was referenced Apr 6, 2022
This was referenced May 3, 2022
Merged
This was referenced May 17, 2022
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.
Problem:
Although most of the codebase is thoroughly documented, there are a few instances where
documentation is lacking. For instance:
In the HubPool contract the public unclaimedAccumulatedProtocolFees variable has no inline
documentation.
In the HubPool contract the inline documentation accompanying
PoolRebalanceLeaf.netSendAmounts, although lengthy, could benefit from additional
clarification around the case of negative values. It could clarify further that in such cases the
actual netSendAmounts value is ignored, but it should match the amountToReturn parameter in
the RelayerRefundLeaf.
Many of the functions in the MerkleLib library are missing NatSpec @return statements.
Solution: all places with missing documentation were updated.