From b64fbd4b1cbc949809e7a0b30fa641c1374b9948 Mon Sep 17 00:00:00 2001 From: Gregory Eremin Date: Sun, 17 Jan 2016 16:45:03 +0300 Subject: [PATCH] Add missing doc comments to base package --- daemon.go | 4 ++++ satan.go | 2 ++ 2 files changed, 6 insertions(+) diff --git a/daemon.go b/daemon.go index 2fb5963..510c10b 100644 --- a/daemon.go +++ b/daemon.go @@ -155,18 +155,22 @@ func (d *BaseDaemon) Continue() bool { } } +// Log logs values using satan.Logger.Println function. func (d *BaseDaemon) Log(v ...interface{}) { if d.logger != nil { d.logger.Println(v...) } } +// Logf logs values using satan.Logger.Printf function. func (d *BaseDaemon) Logf(format string, v ...interface{}) { if d.logger != nil { d.logger.Printf(format, v...) } } +// Shutdown is the empty implementation of the daemons' Shutdown function that +// is inherited and used by default. func (d *BaseDaemon) Shutdown() {} // String returns the name of the Deamon unerlying struct. diff --git a/satan.go b/satan.go index 4b3e015..4bed3c3 100644 --- a/satan.go +++ b/satan.go @@ -66,6 +66,8 @@ type task struct { } const ( + // DefaultNumWorkers is the default number of workers that would process + // tasks. DefaultNumWorkers = 100 )