Document the safe reward notifier requirements in UniStaker natspec #60
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
apbendi
force-pushed
the
document-issue
branch
from
58ec648
to
074018f
Compare
alexkeating
approved these changes
Feb 21, 2024
Also adds return params to public view methods for consistencey within generated docs.
apbendi
force-pushed
the
document-issue
branch
from
074018f
to
cda8921
Compare
|
Coverage after merging document-issue into main will be
Coverage Report
|
|||||||||||||||||||||||||
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.
Adds natspec documentation and code comments to make the requirements of would-be reward notifier contracts explicit and clear. This serves as (code level) documentation of the issue described in #59.