Skip to content

Commit

Permalink
Add corresponding newlines in in-code Multisig doc
Browse files Browse the repository at this point in the history
  • Loading branch information
immrsd committed Dec 17, 2024
1 parent 7b4ba48 commit 6146c2b
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions packages/governance/src/multisig/multisig.cairo
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,7 @@ pub mod MultisigComponent {
/// - `new_quorum` must be less than or equal to the total number of signers after addition.
///
/// Emits a `SignerAdded` event for each signer added.
///
/// Emits a `QuorumUpdated` event if the quorum changes.
fn add_signers(
ref self: ComponentState<TContractState>,
Expand All @@ -270,6 +271,7 @@ pub mod MultisigComponent {
/// - `new_quorum` must be less than or equal to the total number of signers after removal.
///
/// Emits a `SignerRemoved` event for each signer removed.
///
/// Emits a `QuorumUpdated` event if the quorum changes.
fn remove_signers(
ref self: ComponentState<TContractState>,
Expand All @@ -290,6 +292,7 @@ pub mod MultisigComponent {
/// - `signer_to_add` must be a non-zero address.
///
/// Emits a `SignerRemoved` event for the removed signer.
///
/// Emits a `SignerAdded` event for the new signer.
fn replace_signer(
ref self: ComponentState<TContractState>,
Expand Down Expand Up @@ -322,6 +325,7 @@ pub mod MultisigComponent {
/// - The transaction must not have been submitted before.
///
/// Emits a `TransactionSubmitted` event.
///
/// Emits a `CallSalt` event if `salt` is not zero.
fn submit_transaction(
ref self: ComponentState<TContractState>,
Expand All @@ -342,6 +346,7 @@ pub mod MultisigComponent {
/// - The transaction must not have been submitted before.
///
/// Emits a `TransactionSubmitted` event.
///
/// Emits a `CallSalt` event if `salt` is not zero.
fn submit_transaction_batch(
ref self: ComponentState<TContractState>, calls: Span<Call>, salt: felt252,
Expand Down Expand Up @@ -468,6 +473,7 @@ pub mod MultisigComponent {
/// - `quorum` must be non-zero and less than or equal to the number of `signers`.
///
/// Emits a `SignerAdded` event for each signer added.
///
/// Emits a `QuorumUpdated` event.
fn initializer(
ref self: ComponentState<TContractState>, quorum: u32, signers: Span<ContractAddress>,
Expand Down Expand Up @@ -540,6 +546,7 @@ pub mod MultisigComponent {
/// after addition.
///
/// Emits a `SignerAdded` event for each new signer added.
///
/// Emits a `QuorumUpdated` event if the quorum changes.
fn _add_signers(
ref self: ComponentState<TContractState>,
Expand Down Expand Up @@ -575,6 +582,7 @@ pub mod MultisigComponent {
/// after removal.
///
/// Emits a `SignerRemoved` event for each signer removed.
///
/// Emits a `QuorumUpdated` event if the quorum changes.
fn _remove_signers(
ref self: ComponentState<TContractState>,
Expand Down Expand Up @@ -618,6 +626,7 @@ pub mod MultisigComponent {
/// - `signer_to_add` must be a non-zero address.
///
/// Emits a `SignerRemoved` event for the removed signer.
///
/// Emits a `SignerAdded` event for the new signer.
fn _replace_signer(
ref self: ComponentState<TContractState>,
Expand Down

0 comments on commit 6146c2b

Please sign in to comment.