diff --git a/example_test.go b/example_test.go index 2c9cf85..477a993 100644 --- a/example_test.go +++ b/example_test.go @@ -627,8 +627,8 @@ func ExampleWithContext() { ), gocron.NewTask( func(ctx context.Context) { - // gocron will pass in a context (either the default Job context, or one - // provided via WithContext) to the job and will cancel the context on shutdown. + // gocron will pass in the context provided via WithContext + // to the job and will cancel the context on shutdown. // This allows you to listen for and handle cancellation within your job. }, ), diff --git a/job.go b/job.go index dd5398f..8bc8d44 100644 --- a/job.go +++ b/job.go @@ -708,11 +708,12 @@ func WithIdentifier(id uuid.UUID) JobOption { } } -// WithContext sets the parent context for the job +// WithContext sets the parent context for the job. // If you set the first argument of your Task func to be a context.Context, -// gocron will pass in a context (either the default Job context, or one -// provided via WithContext) to the job and will cancel the context on shutdown. -// This allows you to listen for and handle cancellation within your job. +// gocron will pass in the provided context to the job and will cancel the +// context on shutdown. If you cancel the context the job will no longer be +// scheduled as well. This allows you to both control the job via a context +// and listen for and handle cancellation within your job. func WithContext(ctx context.Context) JobOption { return func(j *internalJob, _ time.Time) error { if ctx == nil {