chore: improve godoc for module.go

modules/light-clients/06-solomachine/module.go

@@ -14,40 +14,43 @@ import (
 var _ module.AppModuleBasic = AppModuleBasic{}
 
 // AppModuleBasic defines the basic application module used by the solo machine light client.
+// Only the RegisterInterfaces function needs to be implemented. All other function perform
+// a no-op.
 type AppModuleBasic struct{}
 
 // Name returns the solo machine module name.
 func (AppModuleBasic) Name() string {
 	return SubModuleName
 }
 
-// RegisterLegacyAminoCodec does nothing. The solo machine client does not support amino.
+// RegisterLegacyAminoCodec performs a no-op. The solo machine client does not support amino.
 func (AppModuleBasic) RegisterLegacyAminoCodec(*codec.LegacyAmino) {}
 
-// RegisterInterfaces registers module concrete types into protobuf Any.
+// RegisterInterfaces registers module concrete types into protobuf Any. This allows core IBC
+// to unmarshal solo machine types.
 func (AppModuleBasic) RegisterInterfaces(registry codectypes.InterfaceRegistry) {
 	RegisterInterfaces(registry)
 }
 
-// DefaultGenesis returns nil
+// DefaultGenesis performs a no-op. Genesis is not supported for solo machine.
 func (AppModuleBasic) DefaultGenesis(cdc codec.JSONCodec) json.RawMessage {
 	return nil
 }
 
-// ValidateGenesis return nil
+// ValidateGenesis performs a no-op. Genesis is not supported for solo machine.
 func (AppModuleBasic) ValidateGenesis(cdc codec.JSONCodec, config client.TxEncodingConfig, bz json.RawMessage) error {
 	return nil
 }
 
 // RegisterGRPCGatewayRoutes performs a no-op.
 func (AppModuleBasic) RegisterGRPCGatewayRoutes(clientCtx client.Context, mux *runtime.ServeMux) {}
 
-// GetTxCmd returns nil.
+// GetTxCmd performs a no-op. Please see the 02-client cli commands.
 func (AppModuleBasic) GetTxCmd() *cobra.Command {
 	return nil
 }
 
-// GetQueryCmd returns nil.
+// GetQueryCmd performs a no-op. Please see the 02-client cli commands.
 func (AppModuleBasic) GetQueryCmd() *cobra.Command {
 	return nil
 }