From 5db40483fd49a55f329892617d7628dacb9675f7 Mon Sep 17 00:00:00 2001 From: immrsd Date: Thu, 7 Nov 2024 18:43:12 +0100 Subject: [PATCH] Make minor doc fixes --- packages/governance/src/multisig/interface.cairo | 3 ++- packages/governance/src/multisig/multisig.cairo | 6 +++--- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/packages/governance/src/multisig/interface.cairo b/packages/governance/src/multisig/interface.cairo index f6eb9d08c..ccc872a50 100644 --- a/packages/governance/src/multisig/interface.cairo +++ b/packages/governance/src/multisig/interface.cairo @@ -6,6 +6,7 @@ use starknet::account::Call; pub type TransactionID = felt252; +/// Represents the possible states of a Multisig transaction. #[derive(Copy, Drop, Serde, PartialEq, Debug)] pub enum TransactionState { NotFound, @@ -14,7 +15,7 @@ pub enum TransactionState { Executed } -/// Interface for a contract providing the Multisig functionality. +/// Interface of a contract providing the Multisig functionality. #[starknet::interface] pub trait IMultisig { fn get_quorum(self: @TState) -> u32; diff --git a/packages/governance/src/multisig/multisig.cairo b/packages/governance/src/multisig/multisig.cairo index a05163d36..1ef79d78e 100644 --- a/packages/governance/src/multisig/multisig.cairo +++ b/packages/governance/src/multisig/multisig.cairo @@ -266,11 +266,12 @@ pub mod MultisigComponent { self._replace_signer(signer_to_remove, signer_to_add); } - /// Changes the quorum value. + /// Updates the quorum value to `new_quorum` if it differs from the current quorum. /// /// Requirements: /// /// - The caller must be the contract itself. + /// - `new_quorum` must be non-zero. /// - `new_quorum` must be less than or equal to the total number of signers. /// /// Emits a `QuorumUpdated` event if the quorum changes. @@ -350,7 +351,6 @@ pub mod MultisigComponent { /// /// Requirements: /// - /// - The caller must be a registered signer. /// - The transaction must exist and not be executed. /// - The caller must have previously confirmed the transaction. /// @@ -623,7 +623,7 @@ pub mod MultisigComponent { self.emit(SignerAdded { signer: signer_to_add }); } - /// Change the quorum value if `new_quorum` is different from the current one. + /// Updates the quorum value to `new_quorum` if it differs from the current quorum. /// /// Requirements: ///