Skip to content

Commit 6a5b42c

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 13a1390 commit 6a5b42c

File tree

1 file changed

+18
-16
lines changed

1 file changed

+18
-16
lines changed

src/lib.rs

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -467,39 +467,41 @@ decl_event! {
467467
<T as frame_system::Trait>::Hash,
468468
<T as frame_system::Trait>::BlockNumber,
469469
{
470-
/// A motion has been proposed by a public account.
470+
/// A motion has been proposed by a public account. [proposal_index, deposit]
471471
Proposed(PropIndex, Balance),
472-
/// A public proposal has been tabled for referendum vote.
472+
/// A public proposal has been tabled for referendum vote. [proposal_index, deposit, depositors]
473473
Tabled(PropIndex, Balance, Vec<AccountId>),
474474
/// An external proposal has been tabled.
475475
ExternalTabled,
476-
/// A referendum has begun.
476+
/// A referendum has begun. [ref_index, threshold]
477477
Started(ReferendumIndex, VoteThreshold),
478-
/// A proposal has been approved by referendum.
478+
/// A proposal has been approved by referendum. [ref_index]
479479
Passed(ReferendumIndex),
480-
/// A proposal has been rejected by referendum.
480+
/// A proposal has been rejected by referendum. [ref_index]
481481
NotPassed(ReferendumIndex),
482-
/// A referendum has been cancelled.
482+
/// A referendum has been cancelled. [ref_index]
483483
Cancelled(ReferendumIndex),
484-
/// A proposal has been enacted.
484+
/// A proposal has been enacted. [ref_index, is_ok]
485485
Executed(ReferendumIndex, bool),
486-
/// An account has delegated their vote to another account.
486+
/// An account has delegated their vote to another account. [who, target]
487487
Delegated(AccountId, AccountId),
488-
/// An account has cancelled a previous delegation operation.
488+
/// An [account] has cancelled a previous delegation operation.
489489
Undelegated(AccountId),
490-
/// An external proposal has been vetoed.
490+
/// An external proposal has been vetoed. [who, proposal_hash, until]
491491
Vetoed(AccountId, Hash, BlockNumber),
492-
/// A proposal's preimage was noted, and the deposit taken.
492+
/// A proposal's preimage was noted, and the deposit taken. [proposal_hash, who, deposit]
493493
PreimageNoted(Hash, AccountId, Balance),
494-
/// A proposal preimage was removed and used (the deposit was returned).
494+
/// A proposal preimage was removed and used (the deposit was returned).
495+
/// [proposal_hash, provider, deposit]
495496
PreimageUsed(Hash, AccountId, Balance),
496-
/// A proposal could not be executed because its preimage was invalid.
497+
/// A proposal could not be executed because its preimage was invalid. [proposal_hash, ref_index]
497498
PreimageInvalid(Hash, ReferendumIndex),
498-
/// A proposal could not be executed because its preimage was missing.
499+
/// A proposal could not be executed because its preimage was missing. [proposal_hash, ref_index]
499500
PreimageMissing(Hash, ReferendumIndex),
500-
/// A registered preimage was removed and the deposit collected by the reaper (last item).
501+
/// A registered preimage was removed and the deposit collected by the reaper.
502+
/// [proposal_hash, provider, deposit, reaper]
501503
PreimageReaped(Hash, AccountId, Balance, AccountId),
502-
/// An account has been unlocked successfully.
504+
/// An [account] has been unlocked successfully.
503505
Unlocked(AccountId),
504506
}
505507
}

0 commit comments

Comments
 (0)