chore: update docs (#14038) (#14039)

(cherry picked from commit 5567828)

Co-authored-by: atheeshp <[email protected]>

x/mint/keeper/keeper.go

@@ -60,7 +60,7 @@ func (k Keeper) Logger(ctx sdk.Context) log.Logger {
 	return ctx.Logger().With("module", "x/"+types.ModuleName)
 }
 
-// get the minter
+// GetMinter returns the minter.
 func (k Keeper) GetMinter(ctx sdk.Context) (minter types.Minter) {
 	store := ctx.KVStore(k.storeKey)
 	bz := store.Get(types.MinterKey)
@@ -72,7 +72,7 @@ func (k Keeper) GetMinter(ctx sdk.Context) (minter types.Minter) {
 	return
 }
 
-// set the minter
+// GetMinter sets the minter.
 func (k Keeper) SetMinter(ctx sdk.Context, minter types.Minter) {
 	store := ctx.KVStore(k.storeKey)
 	bz := k.cdc.MustMarshal(&minter)

x/mint/keeper/migrator.go

@@ -12,6 +12,7 @@ type Migrator struct {
 	legacySubspace exported.Subspace
 }
 
+// NewMigrator returns Migrator instance for the state migration.
 func NewMigrator(k Keeper, ss exported.Subspace) Migrator {
 	return Migrator{
 		keeper:         k,

x/mint/keeper/msg_server.go

@@ -11,6 +11,7 @@ import (
 
 var _ types.MsgServer = msgServer{}
 
+// msgServer is a wrapper of Keeper.
 type msgServer struct {
 	Keeper
 }
@@ -22,6 +23,7 @@ func NewMsgServerImpl(k Keeper) types.MsgServer {
 	}
 }
 
+// UpdateParams updates the params.
 func (ms msgServer) UpdateParams(goCtx context.Context, req *types.MsgUpdateParams) (*types.MsgUpdateParamsResponse, error) {
 	if ms.authority != req.Authority {
 		return nil, errors.Wrapf(govtypes.ErrInvalidSigner, "invalid authority; expected %s, got %s", ms.authority, req.Authority)

x/mint/types/codec.go

@@ -36,6 +36,7 @@ func RegisterLegacyAminoCodec(cdc *codec.LegacyAmino) {
 	legacy.RegisterAminoMsg(cdc, &MsgUpdateParams{}, "cosmos-sdk/x/mint/MsgUpdateParams")
 }
 
+// RegisterInterfaces registers the interfaces types with the interface registry.
 func RegisterInterfaces(registry types.InterfaceRegistry) {
 	registry.RegisterImplementations(
 		(*sdk.Msg)(nil),

x/mint/types/minter.go

@@ -33,7 +33,7 @@ func DefaultInitialMinter() Minter {
 	)
 }
 
-// validate minter
+// ValidateMinter does a basic validation on minter.
 func ValidateMinter(minter Minter) error {
 	if minter.Inflation.IsNegative() {
 		return fmt.Errorf("mint parameter Inflation should be positive, is %s",

x/mint/types/params.go

@@ -34,7 +34,7 @@ func DefaultParams() Params {
 	}
 }
 
-// validate params
+// Validate does the sanity check on the params.
 func (p Params) Validate() error {
 	if err := validateMintDenom(p.MintDenom); err != nil {
 		return err