Skip to content

Commit

Permalink
Make minor doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
immrsd committed Nov 7, 2024
1 parent f3c0f9d commit 5db4048
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
3 changes: 2 additions & 1 deletion packages/governance/src/multisig/interface.cairo
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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<TState> {
fn get_quorum(self: @TState) -> u32;
Expand Down
6 changes: 3 additions & 3 deletions packages/governance/src/multisig/multisig.cairo
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
///
Expand Down Expand Up @@ -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:
///
Expand Down

0 comments on commit 5db4048

Please sign in to comment.