improve comments

cosmos · Apr 17, 2021 · d99861a · d99861a
1 parent 11114bc
commit d99861a
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 6 deletions.
diff --git a/x/gov/keeper/deposit.go b/x/gov/keeper/deposit.go
@@ -150,7 +150,7 @@ func (keeper Keeper) AddDeposit(ctx sdk.Context, proposalID uint64, depositorAdd
 		deposit = types.NewDeposit(proposalID, depositorAddr, depositAmount)
 	}
 
-	// called when deposit finish
+	// called when deposit has been added to a proposal, however the proposal may not be active
 	keeper.AfterProposalDeposit(ctx, proposalID, depositorAddr)
 
 	ctx.EventManager().EmitEvent(

diff --git a/x/gov/keeper/proposal.go b/x/gov/keeper/proposal.go
@@ -41,7 +41,7 @@ func (keeper Keeper) SubmitProposal(ctx sdk.Context, content types.Content) (typ
 	keeper.InsertInactiveProposalQueue(ctx, proposalID, proposal.DepositEndTime)
 	keeper.SetProposalID(ctx, proposalID+1)
 
-	// called when proposal is submitted
+	// called right after a proposal is submitted
 	keeper.AfterProposalSubmission(ctx, proposalID)
 
 	ctx.EventManager().EmitEvent(

diff --git a/x/gov/keeper/vote.go b/x/gov/keeper/vote.go
@@ -27,7 +27,7 @@ func (keeper Keeper) AddVote(ctx sdk.Context, proposalID uint64, voterAddr sdk.A
 	vote := types.NewVote(proposalID, voterAddr, options)
 	keeper.SetVote(ctx, vote)
 
-	// called when vote on a proposal
+	// called after a vote on a proposal is cast
 	keeper.AfterProposalVote(ctx, proposalID, voterAddr)
 
 	ctx.EventManager().EmitEvent(

diff --git a/x/gov/types/expected_keepers.go b/x/gov/types/expected_keepers.go
@@ -55,9 +55,9 @@ type BankKeeper interface {
 
 // GovHooks event hooks for governance proposal object (noalias)
 type GovHooks interface {
-	AfterProposalSubmission(ctx sdk.Context, proposalID uint64)                            // Must be called when proposal is submitted
-	AfterProposalDeposit(ctx sdk.Context, proposalID uint64, depositorAddr sdk.AccAddress) // Must be called when a deposit is made
-	AfterProposalVote(ctx sdk.Context, proposalID uint64, voterAddr sdk.AccAddress)        // Must be called when a vote on a proposal is cast
+	AfterProposalSubmission(ctx sdk.Context, proposalID uint64)                            // Must be called after proposal is submitted
+	AfterProposalDeposit(ctx sdk.Context, proposalID uint64, depositorAddr sdk.AccAddress) // Must be called after a deposit is made
+	AfterProposalVote(ctx sdk.Context, proposalID uint64, voterAddr sdk.AccAddress)        // Must be called after a vote on a proposal is cast
 	AfterProposalInactive(ctx sdk.Context, proposalID uint64)                              // Must be called when proposal become inactive
 	AfterProposalActive(ctx sdk.Context, proposalID uint64)                                // Must be called when proposal become active
 }