docs: fix comments that don't match code (cosmos#25785)

Author: warpbuild-benchmark-bot[bot]

codec/proto_codec.go

@@ -278,7 +278,7 @@ func (pc *ProtoCodec) MarshalInterfaceJSON(x gogoproto.Message) ([]byte, error)
 // Example:
 //
 //	var x MyInterface  // must implement proto.Message
-//	err := cdc.UnmarshalInterfaceJSON(&x, bz)
+//	err := cdc.UnmarshalInterfaceJSON(bz, &x)
 func (pc *ProtoCodec) UnmarshalInterfaceJSON(bz []byte, iface any) error {
 	any := &types.Any{}
 	err := pc.UnmarshalJSON(bz, any)

proto/cosmos/staking/v1beta1/query.proto

@@ -148,7 +148,7 @@ message QueryValidatorsResponse {
   cosmos.base.query.v1beta1.PageResponse pagination = 2;
 }
 
-// QueryValidatorRequest is response type for the Query/Validator RPC method
+// QueryValidatorRequest is request type for the Query/Validator RPC method
 message QueryValidatorRequest {
   // validator_addr defines the validator address to query for.
   string validator_addr = 1 [(cosmos_proto.scalar) = "cosmos.ValidatorAddressString"];

store/cachekv/store.go

@@ -223,7 +223,7 @@ func findStartIndex(strL []string, startQ string) int {
 		midStr := strL[mid]
 		if midStr == startQ {
 			// Handle condition where there might be multiple values equal to startQ.
-			// We are looking for the very first value < midStL, that i+1 will be the first
+			// We are looking for the very first value < midStr, that i+1 will be the first
 			// element >= midStr.
 			for i := mid - 1; i >= 0; i-- {
 				if strL[i] != midStr {
@@ -234,7 +234,7 @@ func findStartIndex(strL []string, startQ string) int {
 		}
 		if midStr < startQ {
 			left = mid + 1
-		} else { // midStrL > startQ
+		} else { // midStr > startQ
 			right = mid - 1
 		}
 	}
@@ -256,8 +256,8 @@ func findEndIndex(strL []string, endQ string) int {
 		mid = (left + right) >> 1
 		midStr := strL[mid]
 		if midStr == endQ {
-			// Handle condition where there might be multiple values equal to startQ.
-			// We are looking for the very first value < midStL, that i+1 will be the first
+			// Handle condition where there might be multiple values equal to endQ.
+			// We are looking for the very first value < midStr, that i+1 will be the first
 			// element >= midStr.
 			for i := mid - 1; i >= 0; i-- {
 				if strL[i] < midStr {
@@ -268,7 +268,7 @@ func findEndIndex(strL []string, endQ string) int {
 		}
 		if midStr < endQ {
 			left = mid + 1
-		} else { // midStrL > startQ
+		} else { // midStr > endQ
 			right = mid - 1
 		}
 	}

types/result.go

@@ -82,7 +82,7 @@ func NewResponseResultTx(res *coretypes.ResultTx, anyTx *codectypes.Any, timesta
 	}
 }
 
-// NewResponseResultBlock returns a BlockResponse given a ResultBlock from CometBFT
+// NewResponseResultBlock returns a cmtproto.Block given a ResultBlock from CometBFT
 func NewResponseResultBlock(res *coretypes.ResultBlock, timestamp string) *cmtproto.Block {
 	if res == nil {
 		return nil

x/gov/keeper/keeper.go

@@ -125,7 +125,7 @@ func NewKeeper(
 	return k
 }
 
-// Hooks gets the hooks for governance *Keeper {
+// Hooks gets the hooks for governance.
 func (k *Keeper) Hooks() types.GovHooks {
 	if k.hooks == nil {
 		// return a no-op implementation if no hooks are set

x/slashing/keeper/signing_info.go

@@ -76,7 +76,7 @@ func (k Keeper) IterateValidatorSigningInfos(ctx context.Context,
 }
 
 // JailUntil attempts to set a validator's JailedUntil attribute in its signing
-// info. It will panic if the signing info does not exist for the validator.
+// info. It returns an error if the signing info does not exist for the validator.
 func (k Keeper) JailUntil(ctx context.Context, consAddr sdk.ConsAddress, jailTime time.Time) error {
 	signInfo, err := k.GetValidatorSigningInfo(ctx, consAddr)
 	if err != nil {
@@ -87,8 +87,8 @@ func (k Keeper) JailUntil(ctx context.Context, consAddr sdk.ConsAddress, jailTim
 	return k.SetValidatorSigningInfo(ctx, consAddr, signInfo)
 }
 
-// Tombstone attempts to tombstone a validator. It will panic if signing info for
-// the given validator does not exist.
+// Tombstone attempts to tombstone a validator. It returns an error if signing info for
+// the given validator does not exist or if the validator is already tombstoned.
 func (k Keeper) Tombstone(ctx context.Context, consAddr sdk.ConsAddress) error {
 	signInfo, err := k.GetValidatorSigningInfo(ctx, consAddr)
 	if err != nil {

x/staking/keeper/keeper.go

@@ -80,7 +80,7 @@ func (k Keeper) Logger(ctx context.Context) log.Logger {
 	return sdkCtx.Logger().With("module", "x/"+types.ModuleName)
 }
 
-// Hooks gets the hooks for staking *Keeper {
+// Hooks gets the hooks for staking.
 func (k *Keeper) Hooks() types.StakingHooks {
 	if k.hooks == nil {
 		// return a no-op implementation if no hooks are set

x/upgrade/keeper/keeper.go

@@ -50,10 +50,11 @@ type Keeper struct {
 
 // NewKeeper constructs an upgrade Keeper which requires the following arguments:
 // skipUpgradeHeights - map of heights to skip an upgrade
-// storeKey - a store key with which to access upgrade's store
+// storeService - a store service with which to access upgrade's store
 // cdc - the app-wide binary codec
 // homePath - root directory of the application's config
 // vs - the interface implemented by baseapp which allows setting baseapp's protocol version field
+// authority - the address capable of executing upgrade proposals
 func NewKeeper(skipUpgradeHeights map[int64]bool, storeService corestore.KVStoreService, cdc codec.BinaryCodec, homePath string, vs xp.ProtocolVersionSetter, authority string) *Keeper {
 	k := &Keeper{
 		homePath:           homePath,