Skip to content

Commit 4d10a06

Browse files
authored
Merge pull request #1716 from sgreene570/fix-signals-package-go-docs
✨ Fix SetupSignalHandler godoc
2 parents 619e6b9 + 11f5650 commit 4d10a06

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

pkg/manager/signals/signal.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ import (
2424

2525
var onlyOneSignalHandler = make(chan struct{})
2626

27-
// SetupSignalHandler registers for SIGTERM and SIGINT. A stop channel is returned
28-
// which is closed on one of these signals. If a second signal is caught, the program
27+
// SetupSignalHandler registers for SIGTERM and SIGINT. A context is returned
28+
// which is canceled on one of these signals. If a second signal is caught, the program
2929
// is terminated with exit code 1.
3030
func SetupSignalHandler() context.Context {
3131
close(onlyOneSignalHandler) // panics when called twice

0 commit comments

Comments
 (0)