(wip)

Author: lucassabreu

pkg/cmd/time-entry/util/defaults/defaults.go

@@ -27,6 +27,7 @@ type ScanParam struct {
 	Filename string
 }
 
+// WriteDefaults persists the default values to a file
 func WriteDefaults(dir, filename string, d DefaultTimeEntry) error {
 	n := filepath.Join(dir, filename)
 	f, err := os.OpenFile(n, os.O_CREATE|os.O_RDWR, os.ModePerm)
@@ -41,20 +42,26 @@ func WriteDefaults(dir, filename string, d DefaultTimeEntry) error {
 	return yaml.NewEncoder(f).Encode(d)
 }
 
+// ScanError wraps errors from scanning for the defaults file
 type ScanError struct {
 	Err error
 }
 
+// Error shows error message
 func (s *ScanError) Error() string {
 	return s.Unwrap().Error()
 }
 
+// Unwrap gives access to the error chain
 func (s *ScanError) Unwrap() error {
 	return s.Err
 }
 
+// DefaultsFileNotFoundErr is returned when the scan can't find any files
 var DefaultsFileNotFoundErr = errors.New("defaults file not found")
 
+// ScanForDefaults scan the directory informed and its parents for the defaults
+// file
 func ScanForDefaults(p ScanParam) func() (DefaultTimeEntry, error) {
 	return func() (DefaultTimeEntry, error) {
 		if p.Filename == "" {