Add extra dev notes about purpose and intention of contract. #43
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
petrovska-petro
approved these changes
Oct 7, 2024
| * @dev This contract is intended to be a helper to aid an incentives manager in working with Balancer gauges. | ||
| * @dev It's intent is to provide maximum flexibility to the owner, not make any guarantees about the future on-chain. | ||
| * @dev A number of safeguards are available to help the owner from making mistakes. | ||
| * @dev Any contract that will be an owner of this contract should either have passthrough functions to change owner, or sweep all funds. |
There was a problem hiding this comment.
overall all these tags are great additions! ✅
the more info/context the better, specially for any corner cases 👍
imo L23, L24 may fall within @dev, while L21 AND 22. can stay as is
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.
Doing a final once over of the contracts and a reflection on our conversations and added this dev note?
That help?