From cc77ac6a107000f338e8fee1fbf4dc98cad7f047 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pablo=20Andr=C3=A9s=20Dorado=20Su=C3=A1rez?= Date: Tue, 30 Jan 2024 12:17:18 -0500 Subject: [PATCH] fix(frame_support/traits:voting): apply suggestions --- substrate/frame/support/src/traits/voting.rs | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/substrate/frame/support/src/traits/voting.rs b/substrate/frame/support/src/traits/voting.rs index f4fb0ef99a5eb..3e658352adbae 100644 --- a/substrate/frame/support/src/traits/voting.rs +++ b/substrate/frame/support/src/traits/voting.rs @@ -27,19 +27,19 @@ use sp_std::prelude::*; pub trait VoteTally { /// 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")]