updated docs for governor votes, 0 is against not for #2915
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
|
Thanks @PatrickAlphaC! For the record, no need to include changelog entries for documentation changes. |
frangio
pushed a commit
that referenced
this pull request
Oct 18, 2021
* updated docs for governor votes, 0 is against not for * Revert unecessary changelog entry Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com> (cherry picked from commit 0db97c9)
|
I almost didn't and then I saw the checklist. I chose to err on the side of caution, but good to know! |
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 docs were outdated. Took me a few hours to find out what was going wrong. In both the compound and oz versions of counting votes, 0 is against, but in the docs, it said 0 was for.
Examples:
openzeppelin-contracts/contracts/governance/IGovernor.sol
Line 76 in 56d4063
openzeppelin-contracts/contracts/governance/compatibility/GovernorCompatibilityBravo.sol
Line 31 in 56d4063
PR Checklist