Skip to content

Commit d0cec34

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 299abd6 commit d0cec34

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

src/lib.rs

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -462,26 +462,27 @@ decl_storage! {
462462

463463
decl_event!(
464464
pub enum Event<T> where AccountId = <T as frame_system::Trait>::AccountId, Balance = BalanceOf<T> {
465-
/// A name was set or reset (which will remove all judgements).
465+
/// A name was set or reset (which will remove all judgements). [who]
466466
IdentitySet(AccountId),
467-
/// A name was cleared, and the given balance returned.
467+
/// A name was cleared, and the given balance returned. [who, deposit]
468468
IdentityCleared(AccountId, Balance),
469-
/// A name was removed and the given balance slashed.
469+
/// A name was removed and the given balance slashed. [who, deposit]
470470
IdentityKilled(AccountId, Balance),
471-
/// A judgement was asked from a registrar.
471+
/// A judgement was asked from a registrar. [who, registrar_index]
472472
JudgementRequested(AccountId, RegistrarIndex),
473-
/// A judgement request was retracted.
473+
/// A judgement request was retracted. [who, registrar_index]
474474
JudgementUnrequested(AccountId, RegistrarIndex),
475-
/// A judgement was given by a registrar.
475+
/// A judgement was given by a registrar. [target, registrar_index]
476476
JudgementGiven(AccountId, RegistrarIndex),
477-
/// A registrar was added.
477+
/// A registrar was added. [registrar_index]
478478
RegistrarAdded(RegistrarIndex),
479-
/// A sub-identity (first) was added to an identity (second) and the deposit paid.
479+
/// A sub-identity was added to an identity and the deposit paid. [sub, main, deposit]
480480
SubIdentityAdded(AccountId, AccountId, Balance),
481-
/// A sub-identity (first) was removed from an identity (second) and the deposit freed.
481+
/// A sub-identity was removed from an identity and the deposit freed.
482+
/// [sub, main, deposit]
482483
SubIdentityRemoved(AccountId, AccountId, Balance),
483-
/// A sub-identity (first arg) was cleared, and the given deposit repatriated from the
484-
/// main identity account (second arg) to the sub-identity account.
484+
/// A sub-identity was cleared, and the given deposit repatriated from the
485+
/// main identity account to the sub-identity account. [sub, main, deposit]
485486
SubIdentityRevoked(AccountId, AccountId, Balance),
486487
}
487488
);

0 commit comments

Comments
 (0)