Apply suggestions from code review

Co-authored-by: yihuang <[email protected]>
Signed-off-by: mmsqe <[email protected]>

types/abci.go

@@ -7,10 +7,8 @@ import (
 // InitChainer initializes application state at genesis
 type InitChainer func(ctx Context, req abci.RequestInitChain) abci.ResponseInitChain
 
-// PreBeginBlocker runs code before the transactions in a block
+// PreBeginBlocker runs code before the `BeginBlocker`.
 //
-// Note: applications which set create_empty_blocks=false will not have regular block timing and should use
-// e.g. BFT timestamps rather than block height for any periodic BeginBlock logic
 
 type ResponsePreBeginBlock struct {
 	ConsensusParamsChanged bool

x/upgrade/abci.go

@@ -86,6 +86,8 @@ func PreBeginBlocker(k *keeper.Keeper, ctx sdk.Context, _ abci.RequestBeginBlock
 		ctx = ctx.WithBlockGasMeter(sdk.NewInfiniteGasMeter())
 		k.ApplyUpgrade(ctx, plan)
 		return sdk.ResponsePreBeginBlock{
+			// the consensus parameters might be modified in the migration,
+			// refresh the consensus parameters in context.
 			ConsensusParamsChanged: true,
 		}, nil
 	}

x/upgrade/module.go

@@ -156,7 +156,7 @@ func (AppModule) ConsensusVersion() uint64 { return consensusVersion }
 
 // PreBeginBlock calls the upgrade module hooks
 //
-// CONTRACT: this is registered in BeginBlocker *before* all other modules' BeginBlock functions
+// CONTRACT: this is called *before* all other modules' BeginBlock functions
 func (am AppModule) PreBeginBlock(ctx sdk.Context, req abci.RequestBeginBlock) (sdk.ResponsePreBeginBlock, error) {
 	return PreBeginBlocker(am.keeper, ctx, req)
 }