app/config: Adding description to methods.

app/config/cli.go

@@ -6,6 +6,7 @@ import (
 	"github.com/urfave/cli/v2"
 )
 
+// Read cli flag values into the config
 func (cfg *Config) ReadCliFlags(ctx *cli.Context) error {
 	logFile := ctx.Path("log")
 	if len(logFile) > 0 {

app/config/config.go

@@ -43,6 +43,7 @@ type Config struct {
 	Telegram TelegramConfig `yaml:"telegram"`
 }
 
+// Create a new Config object with default values
 func New() Config {
 	return Config{
 		MessageCodec: "json",

app/config/file.go

@@ -4,6 +4,7 @@ import (
 	"os"
 )
 
+// Read values from file
 func (cfg *Config) ReadFile(filename string) error {
 	bytes, err := os.ReadFile(filename)
 	if err != nil {

app/config/yaml.go

@@ -20,6 +20,7 @@ func (ship *ShipConfig) UnmarshalYAML(value *yaml.Node) error {
 	return err
 }
 
+// Read YAML config data
 func (cfg *Config) ReadYAML(data []byte) error {
 	return yaml.Unmarshal(data, cfg)
 }