add comments

cenkalti · Sep 11, 2020 · f12e3aa · f12e3aa
1 parent 230e44a
commit f12e3aa
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/client.go b/client.go
@@ -16,6 +16,7 @@ import (
 	"github.com/senseyeio/duration"
 )
 
+// ErrNotExist is returned when requested job does not exist.
 var ErrNotExist = table.ErrNotExist
 
 // ClientOpt is an option that can be provided to a Dalga client.

diff --git a/config.go b/config.go
@@ -5,6 +5,8 @@ import (
 	"time"
 )
 
+// DefaultConfig contains sensible defaults for Dalga instance.
+// For a simple deployment, you only need to override MySQL options.
 var DefaultConfig = Config{
 	Jobs: jobsConfig{
 		RetryInterval:    time.Minute,
@@ -33,6 +35,7 @@ var DefaultConfig = Config{
 	},
 }
 
+// Config values for Dalga instance.
 type Config struct {
 	Jobs     jobsConfig
 	MySQL    mysqlConfig