From f12e3aad1b13ed1f19eaa4a5d750d90ca0fb82dc Mon Sep 17 00:00:00 2001 From: Cenk Alti Date: Sat, 12 Sep 2020 00:28:22 +0300 Subject: [PATCH] add comments --- client.go | 1 + config.go | 3 +++ 2 files changed, 4 insertions(+) diff --git a/client.go b/client.go index ab2f69c..f4aef8f 100644 --- 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 index 51cacf3..a2dd757 100644 --- 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