Skip to content

Commit f30de33

Browse files
committed
Add missing comments
1 parent d14754e commit f30de33

3 files changed

Lines changed: 7 additions & 0 deletions

File tree

‎config/config.go‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,10 +80,12 @@ func (c *Config) SavePath(file string) {
8080
}
8181
}
8282

83+
// File represents the path to the config file.
8384
func (c *Config) File() string {
8485
return c.file
8586
}
8687

88+
// Write() saves the config as JSON.
8789
func (c *Config) Write() error {
8890
renameLegacy()
8991

@@ -101,6 +103,7 @@ func (c *Config) Write() error {
101103
return nil
102104
}
103105

106+
// Read loads the config from the stored JSON file.
104107
func Read(file string) (*Config, error) {
105108
renameLegacy()
106109

‎handlers/configure.go‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ import (
88
"github.com/exercism/cli/config"
99
)
1010

11+
// Configure stores settings in a JSON file.
12+
// If a setting is not passed as an argument, default
13+
// values are used.
1114
func Configure(ctx *cli.Context) {
1215
key := ctx.String("key")
1316
host := ctx.String("host")

‎handlers/debug.go‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ import (
1010
"github.com/exercism/cli/config"
1111
)
1212

13+
// Debug provides information about the user's environment and configuration.
1314
func Debug(ctx *cli.Context) {
1415
defer fmt.Printf("\nIf you are having any issues, please contact kytrinyx@exercism.io with this information.\n")
1516

0 commit comments

Comments
 (0)