From 6146c2b4a77a8d2b77b7864aee30a322a88094a0 Mon Sep 17 00:00:00 2001 From: immrsd Date: Tue, 17 Dec 2024 20:04:24 +0100 Subject: [PATCH] Add corresponding newlines in in-code Multisig doc --- packages/governance/src/multisig/multisig.cairo | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/packages/governance/src/multisig/multisig.cairo b/packages/governance/src/multisig/multisig.cairo index e65c8f3ce..27f103bda 100644 --- a/packages/governance/src/multisig/multisig.cairo +++ b/packages/governance/src/multisig/multisig.cairo @@ -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, @@ -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, @@ -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, @@ -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, @@ -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, calls: Span, salt: felt252, @@ -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, quorum: u32, signers: Span, @@ -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, @@ -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, @@ -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,