fix(optimistic-rewarder): [L05] improved natspec commenting#3679
Merged
chrismaree merged 1 commit intomasterfrom Dec 13, 2021
Merged
fix(optimistic-rewarder): [L05] improved natspec commenting#3679chrismaree merged 1 commit intomasterfrom
chrismaree merged 1 commit intomasterfrom
Conversation
Signed-off-by: chrismaree <christopher.maree@gmail.com>
nicholaspai
approved these changes
Dec 10, 2021
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Motivation
OZ identified the following issue:
Many functions in the OptimisticRewarderBase contract are missing the @return parameter in their
Natural Specification comments. Consider including it for completeness.
This PR fixes this and adds a few other small commenting changes to the
OptimisticRewarderBase.Testing
Check a box to describe how you tested these changes and list the steps for reviewers to test.