Skip to content

Commit

Permalink
fix(frame_support/traits:voting): apply suggestions
Browse files Browse the repository at this point in the history
  • Loading branch information
pandres95 committed Jan 30, 2024
1 parent bb29c3a commit cc77ac6
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions substrate/frame/support/src/traits/voting.rs
Original file line number Diff line number Diff line change
Expand Up @@ -27,19 +27,19 @@ use sp_std::prelude::*;
pub trait VoteTally<Votes, Class> {
/// Initializes a new tally
fn new(_: Class) -> Self;
/// Returns the amount of positive votes for the tally
/// Returns the number of positive votes for the tally.
fn ayes(&self, class: Class) -> Votes;
/// Retrieves the ratio of positive votes for the tally, without multipliers (i.e. conviction, ranks, etc.)
/// Returns the approval ratio (positive to total votes) for the tally, without multipliers (i.e. conviction, ranks, etc.).
fn support(&self, class: Class) -> Perbill;
/// Retrieves the ratio of approval (positive / total) votes for the tally
/// Returns the approval ratio (positive to total votes) for the tally.
fn approval(&self, class: Class) -> Perbill;
/// Returns an instance of the tally representing an unanumous approval, for benchmarking purposes
/// Returns an instance of the tally representing a unanimous approval, for benchmarking purposes.
#[cfg(feature = "runtime-benchmarks")]
fn unanimity(class: Class) -> Self;
/// Returns an instance of the tally representing an rejecting state, for benchmarking purposes
/// Returns an instance of the tally representing a rejecting state, for benchmarking purposes.
#[cfg(feature = "runtime-benchmarks")]
fn rejection(class: Class) -> Self;
/// Returns an instance of the tally given some `approval` and `support`, for benchmarking purposes
/// Returns an instance of the tally given some `approval` and `support`, for benchmarking purposes.
#[cfg(feature = "runtime-benchmarks")]
fn from_requirements(support: Perbill, approval: Perbill, class: Class) -> Self;
#[cfg(feature = "runtime-benchmarks")]
Expand Down

0 comments on commit cc77ac6

Please sign in to comment.