summaryrefslogtreecommitdiff
path: root/internal
diff options
context:
space:
mode:
authorPaul Buetow <pbuetow@mimecast.com>2021-12-03 09:38:33 +0000
committerPaul Buetow <pbuetow@mimecast.com>2021-12-03 09:38:33 +0000
commitb1ff5bf140dbf4bdb43352a50d65d392abbd4025 (patch)
tree50d143b86e90762083085ef8eeb2d2a66cd0821c /internal
parentbbe613ab1fe6dc8875b8a06af4f373693e253242 (diff)
comment why none logger documentation is empty
Diffstat (limited to 'internal')
-rw-r--r--internal/io/dlog/loggers/none.go33
1 files changed, 25 insertions, 8 deletions
diff --git a/internal/io/dlog/loggers/none.go b/internal/io/dlog/loggers/none.go
index 973ae3c..a685862 100644
--- a/internal/io/dlog/loggers/none.go
+++ b/internal/io/dlog/loggers/none.go
@@ -9,13 +9,30 @@ import (
// don't log anything
type none struct{}
-func (none) Start(ctx context.Context, wg *sync.WaitGroup) { wg.Done() }
-func (none) Log(now time.Time, message string) {}
+func (none) Start(ctx context.Context, wg *sync.WaitGroup) { wg.Done() }
+
+// Log is empty because the none isn't logging but has to statify the interface.
+func (none) Log(now time.Time, message string) {}
+
+// LogWithColora is empty because the none isn't logging but has to statify the interface.
func (none) LogWithColors(now time.Time, message, coloredMessage string) {}
-func (none) Raw(now time.Time, message string) {}
+
+// Raw is empty because the none isn't logging but has to statify the interface.
+func (none) Raw(now time.Time, message string) {}
+
+// RawWithColors is empty because the none isn't logging but has to statify the interface.
func (none) RawWithColors(now time.Time, message, coloredMessage string) {}
-func (none) Flush() {}
-func (none) Pause() {}
-func (none) Resume() {}
-func (none) Rotate() {}
-func (none) SupportsColors() bool { return false }
+
+// Flush is empty because the none isn't logging but has to statify the interface.
+func (none) Flush() {}
+
+// Pause is empty because the none isn't logging but has to statify the interface.
+func (none) Pause() {}
+
+// Resume is empty because the none isn't logging but has to statify the interface.
+func (none) Resume() {}
+
+// Rotate is empty because the none isn't logging but has to statify the interface.
+func (none) Rotate() {}
+
+func (none) SupportsColors() bool { return false }