Skip to content

Commit 3465cb2

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 79d519e commit 3465cb2

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

src/lib.rs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -184,19 +184,26 @@ decl_event! {
184184
{
185185
/// A motion (given hash) has been proposed (by given account) with a threshold (given
186186
/// `MemberCount`).
187+
/// [account, proposal_index, proposal_hash, threshold]
187188
Proposed(AccountId, ProposalIndex, Hash, MemberCount),
188189
/// A motion (given hash) has been voted on by given account, leaving
189190
/// a tally (yes votes and no votes given respectively as `MemberCount`).
191+
/// [account, proposal_hash, voted, yes, no]
190192
Voted(AccountId, Hash, bool, MemberCount, MemberCount),
191193
/// A motion was approved by the required threshold.
194+
/// [proposal_hash]
192195
Approved(Hash),
193196
/// A motion was not approved by the required threshold.
197+
/// [proposal_hash]
194198
Disapproved(Hash),
195199
/// A motion was executed; result will be `Ok` if it returned without error.
200+
/// [proposal_hash, result]
196201
Executed(Hash, DispatchResult),
197202
/// A single member did some action; result will be `Ok` if it returned without error.
203+
/// [proposal_hash, result]
198204
MemberExecuted(Hash, DispatchResult),
199205
/// A proposal was closed because its threshold was reached or after its duration was up.
206+
/// [proposal_hash, yes, no]
200207
Closed(Hash, MemberCount, MemberCount),
201208
}
202209
}

0 commit comments

Comments
 (0)