From e6d805119f0abd7335b98a0bac8050b286b2dd1a Mon Sep 17 00:00:00 2001
From: Rowan Bohde <rowan.bohde@gmail.com>
Date: Wed, 1 May 2024 16:28:13 -0500
Subject: [PATCH] fix: comment NullLogger
---
internal/app/run/logging.go | 6 +++++-
1 file changed, 5 insertions(+), 1 deletion(-)
diff --git a/internal/app/run/logging.go b/internal/app/run/logging.go
index 17fd37f..f97e9a6 100644
--- a/internal/app/run/logging.go
+++ b/internal/app/run/logging.go
@@ -6,8 +6,12 @@ import (
log "github.com/sirupsen/logrus"
)
-type NullLogger struct {}
+// NullLogger is used to create a new JobLogger to discard logs. This
+// will prevent these logs from being logged to the stdout, but
+// forward them to the Reporter via its hook.
+type NullLogger struct{}
+// WithJobLogger creates a new logrus.Logger that will discard all logs.
func (n NullLogger) WithJobLogger() *log.Logger {
logger := log.New()
logger.SetOutput(io.Discard)