Skip to content

Commit

Permalink
fix description for SetupSignalHandler()
Browse files Browse the repository at this point in the history 
fix description for SetupSignalHandler() in alias.go to match actual behaviour of returning a context (instead of a channel)
  • Loading branch information
@dzacball
dzacball committed May 15, 2024
1 parent 5dcea7e commit 358286f
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions alias.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,8 @@ var (
// there is another OwnerReference with Controller flag set.
SetControllerReference = controllerutil.SetControllerReference

// SetupSignalHandler registered 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.
SetupSignalHandler = signals.SetupSignalHandler

Expand Down

0 comments on commit 358286f

Please sign in to comment.