Skip to content

Commit c59aa12

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 ad8d228 commit c59aa12

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

src/lib.rs

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1238,28 +1238,30 @@ decl_storage! {
12381238
decl_event!(
12391239
pub enum Event<T> where Balance = BalanceOf<T>, <T as frame_system::Trait>::AccountId {
12401240
/// The era payout has been set; the first balance is the validator-payout; the second is
1241-
/// the remainder from the maximum amount of reward.
1241+
/// the remainder from the maximum amount of reward.
1242+
/// [era_index, validator_payout, remainder]
12421243
EraPayout(EraIndex, Balance, Balance),
1243-
/// The staker has been rewarded by this amount. `AccountId` is the stash account.
1244+
/// The staker has been rewarded by this amount. [stash, amount]
12441245
Reward(AccountId, Balance),
1245-
/// One validator (and its nominators) has been slashed by the given amount.
1246+
/// One validator (and its nominators) has been slashed by the given amount.
1247+
/// [validator, amount]
12461248
Slash(AccountId, Balance),
12471249
/// An old slashing report from a prior era was discarded because it could
1248-
/// not be processed.
1250+
/// not be processed. [session_index]
12491251
OldSlashingReportDiscarded(SessionIndex),
1250-
/// A new set of stakers was elected with the given computation method.
1252+
/// A new set of stakers was elected with the given [compute].
12511253
StakingElection(ElectionCompute),
1252-
/// A new solution for the upcoming election has been stored.
1254+
/// A new solution for the upcoming election has been stored. [compute]
12531255
SolutionStored(ElectionCompute),
1254-
/// An account has bonded this amount.
1256+
/// An account has bonded this amount. [stash, amount]
12551257
///
12561258
/// NOTE: This event is only emitted when funds are bonded via a dispatchable. Notably,
12571259
/// it will not be emitted for staking rewards when they are added to stake.
12581260
Bonded(AccountId, Balance),
1259-
/// An account has unbonded this amount.
1261+
/// An account has unbonded this amount. [stash, amount]
12601262
Unbonded(AccountId, Balance),
12611263
/// An account has called `withdraw_unbonded` and removed unbonding chunks worth `Balance`
1262-
/// from the unlocking queue.
1264+
/// from the unlocking queue. [stash, amount]
12631265
Withdrawn(AccountId, Balance),
12641266
}
12651267
);

0 commit comments

Comments
 (0)