Add more documentation #90
Merged
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
wildmolasses
approved these changes
Dec 13, 2024
src/GovernanceStaker.sol
Outdated
| /// @dev An earning power calculator should take into account that a deposit's earning power is an | ||
| /// uint96. There may be overflow issues within governance staker if this is not taken into | ||
| /// account. Also, there should be some mechanism to prevent the deposit from frequently being | ||
| /// bumpable if earning power changes frequently as this will eat into a users unclaimed rewards. |
There was a problem hiding this comment.
Suggested change
| /// bumpable if earning power changes frequently as this will eat into a users unclaimed rewards. | |
| /// bumpable: if earning power changes frequently, this will eat into a users unclaimed rewards. |
|
Coverage after merging fix/add-more-documentation 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.
Description