Skip to content

Commit 776ab5b

Browse files
authored
More app-friendly event description (#6684)
* More app-friendly event description * change origin -> owner * checked all decl_event! and changed decriptions. * annotated parameter names for remaining events
1 parent 73efb1e commit 776ab5b

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

src/lib.rs

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -660,19 +660,21 @@ decl_event! {
660660
<T as frame_system::Trait>::AccountId,
661661
<T as frame_system::Trait>::Hash
662662
{
663-
/// Contract deployed by address at the specified address.
663+
/// Contract deployed by address at the specified address. [owner, contract]
664664
Instantiated(AccountId, AccountId),
665665

666666
/// Contract has been evicted and is now in tombstone state.
667-
///
667+
/// [contract, tombstone]
668+
///
668669
/// # Params
669670
///
670671
/// - `contract`: `AccountId`: The account ID of the evicted contract.
671672
/// - `tombstone`: `bool`: True if the evicted contract left behind a tombstone.
672673
Evicted(AccountId, bool),
673674

674675
/// Restoration for a contract has been successful.
675-
///
676+
/// [donor, dest, code_hash, rent_allowance]
677+
///
676678
/// # Params
677679
///
678680
/// - `donor`: `AccountId`: Account ID of the restoring contract
@@ -682,12 +684,14 @@ decl_event! {
682684
Restored(AccountId, AccountId, Hash, Balance),
683685

684686
/// Code with the specified hash has been stored.
687+
/// [code_hash]
685688
CodeStored(Hash),
686689

687-
/// Triggered when the current schedule is updated.
690+
/// Triggered when the current [schedule] is updated.
688691
ScheduleUpdated(u32),
689692

690693
/// An event deposited upon execution of a contract from the account.
694+
/// [account, data]
691695
ContractExecution(AccountId, Vec<u8>),
692696
}
693697
}

0 commit comments

Comments
 (0)