Skip to content

Commit 162bd85

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 f4e4c71 commit 162bd85

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

src/lib.rs

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -264,17 +264,21 @@ decl_event! {
264264
pub enum Event<T> where
265265
AccountId = <T as system::Trait>::AccountId,
266266
{
267-
/// A recovery process has been set up for an account
267+
/// A recovery process has been set up for an [account].
268268
RecoveryCreated(AccountId),
269-
/// A recovery process has been initiated for account_1 by account_2
269+
/// A recovery process has been initiated for lost account by rescuer account.
270+
/// [lost, rescuer]
270271
RecoveryInitiated(AccountId, AccountId),
271-
/// A recovery process for account_1 by account_2 has been vouched for by account_3
272+
/// A recovery process for lost account by rescuer account has been vouched for by sender.
273+
/// [lost, rescuer, sender]
272274
RecoveryVouched(AccountId, AccountId, AccountId),
273-
/// A recovery process for account_1 by account_2 has been closed
275+
/// A recovery process for lost account by rescuer account has been closed.
276+
/// [lost, rescuer]
274277
RecoveryClosed(AccountId, AccountId),
275-
/// Account_1 has been successfully recovered by account_2
278+
/// Lost account has been successfully recovered by rescuer account.
279+
/// [lost, rescuer]
276280
AccountRecovered(AccountId, AccountId),
277-
/// A recovery process has been removed for an account
281+
/// A recovery process has been removed for an [account].
278282
RecoveryRemoved(AccountId),
279283
}
280284
}

0 commit comments

Comments
 (0)