[Documentation] Add description for VoteTally's methods #3140
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
pandres95
force-pushed
the
pandres95--document-trait-votetally
branch
from
891f717
to
bb29c3a
Compare
There was a problem hiding this comment.
Sentences should have a period at the end.
While methods' names on VoteTally trait might be self-explanatory at first sight, the distinction between support and approval can be a bit ambiguous for some readers.
Isn't this explained in the Tally struct?
pandres95
force-pushed
the
pandres95--document-trait-votetally
branch
4 times, most recently
from
cc77ac6
to
4babf3c
Compare
It is explained, but specifically for the context of the conviction voting's |
pandres95
force-pushed
the
pandres95--document-trait-votetally
branch
from
6c6cdb1
to
60b2b89
Compare
joepetrowski
approved these changes
Jan 31, 2024
bkchr
approved these changes
Jan 31, 2024
bgallois
pushed a commit
to duniter/duniter-polkadot-sdk
that referenced
this pull request
Mar 25, 2024
) # Description While methods' names on [`VoteTally`][1] trait might be self-explanatory at first sight, the distinction between `support` and `approval` can be a bit ambiguous for some readers. This PR aims to clarify the distinction and inform about the expected values for every not yet documented method on this trait. # Checklist - [x] My PR includes a detailed description as outlined in the "Description" section above - [ ] My PR follows the [labeling requirements](CONTRIBUTING.md#Process) of this project (at minimum one label for `T` required) - [x] I have made corresponding changes to the documentation (if applicable) - [x] I have added tests that prove my fix is effective or that my feature works (if applicable) [1]: https://docs.rs/frame-support/latest/frame_support/traits/trait.VoteTally.html --------- Co-authored-by: Bastian Köcher <git@kchr.de>
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
While methods' names on
VoteTallytrait might be self-explanatory at first sight, the distinction betweensupportandapprovalcan be a bit ambiguous for some readers. This PR aims to clarify the distinction and inform about the expected values for every not yet documented method on this trait.Checklist
Trequired)