Merge pull request #1716 from sgreene570/fix-signals-package-go-docs

✨ Fix SetupSignalHandler godoc
kubernetes-sigs · Nov 15, 2021 · 4d10a06 · 4d10a06
2 parents 619e6b9 + 11f5650
commit 4d10a06
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/pkg/manager/signals/signal.go b/pkg/manager/signals/signal.go
@@ -24,8 +24,8 @@ import (
 
 var onlyOneSignalHandler = make(chan struct{})
 
-// SetupSignalHandler registers for SIGTERM and SIGINT. A stop channel is returned
-// which is closed on one of these signals. If a second signal is caught, the program
+// SetupSignalHandler registers for SIGTERM and SIGINT. A context is returned
+// which is canceled on one of these signals. If a second signal is caught, the program
 // is terminated with exit code 1.
 func SetupSignalHandler() context.Context {
 	close(onlyOneSignalHandler) // panics when called twice