refactor: simple quorum comment and var name #246
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
The natspec comment mentioned that the quorum was calculated from all vote types when actually it is calculated from just for and abstain votes. Additionally, in the `_quorumReached` internal function, `totalVotes` was used as the variable name for the sum of for and abstain votes. This is misleading. This PR therefore updates the comment and renamed the `totalVotes` var to `forAndAbstainVotesTotal`.
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.
The natspec comment mentioned that the quorum was calculated from all vote types when actually it is calculated from just for and abstain votes.
Additionally, in the
_quorumReachedinternal function,totalVoteswas used as the variable name for the sum of for and abstain votes. This is misleading.This PR therefore updates the comment and renamed the
totalVotesvar toforAndAbstainVotesTotal.