improve: [L-01] Incorrect or misleading documentation #251
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
Several instances of docstrings or comments in the codebase were found to be erroneous. In particular: - In the SpokePool contract's `_fillRelay` function, the comment on line 1003 appears unrelated to the if statement on the following line. Consider revising the comment. - The docstring for `pauseDeposits` in the SpokePool contract says it "pauses deposit and fill functions", but pausing fill functions is performed by calling `pauseFills` , which does not have a docstring. Consider revising the `pauseDeposits` docstring and adding a docstring to `pauseFills`.
nicholaspai
added
the
OZ Audit - March 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.
From Audit
Several instances of docstrings or comments in the codebase were found to be erroneous. In
particular:
_fillRelayfunction, the comment on line 1003appears unrelated to the if statement on the following line. Consider revising the
comment.
pauseDepositsin the SpokePool contract says it "pauses depositand fill functions", but pausing fill functions is performed by calling
pauseFills, whichdoes not have a docstring.
Consider revising the
pauseDepositsdocstring and adding a docstring topauseFills.