diff --git a/example_test.go b/example_test.go index 9fabe2f..ac6efbd 100644 --- a/example_test.go +++ b/example_test.go @@ -362,8 +362,9 @@ func ExampleNewTask() { gocron.DurationJob(time.Second), gocron.NewTask( func(ctx context.Context) { - // gocron will pass in a context to the job and will cancel on shutdown. - // this allows you to listen for and handle cancellation within your job. + // 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. }, ), ) @@ -626,8 +627,9 @@ func ExampleWithContext() { ), gocron.NewTask( func(ctx context.Context) { - // gocron will pass in a context to the job and will cancel on shutdown. - // this allows you to listen for and handle cancellation within your job. + // 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.WithContext(ctx), diff --git a/job.go b/job.go index 1062fdf..a543a44 100644 --- a/job.go +++ b/job.go @@ -84,7 +84,8 @@ type Task func() task // NewTask provides the job's task function and parameters. // If you set the first argument of your Task func to be a context.Context, -// gocron will pass in a context to the job and will cancel on shutdown. +// 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. func NewTask(function any, parameters ...any) Task { return func() task { @@ -709,7 +710,8 @@ func WithIdentifier(id uuid.UUID) JobOption { // 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 to the job and will cancel on shutdown. +// 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. func WithContext(ctx context.Context) JobOption { return func(j *internalJob, _ time.Time) error { diff --git a/scheduler.go b/scheduler.go index 4a7d538..112870f 100644 --- a/scheduler.go +++ b/scheduler.go @@ -22,7 +22,8 @@ type Scheduler interface { // definition when the Scheduler is started. If the Scheduler is already running // the job will be scheduled when the Scheduler is started. // If you set the first argument of your Task func to be a context.Context, - // gocron will pass in a context to the job and will cancel on shutdown. + // 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. NewJob(JobDefinition, Task, ...JobOption) (Job, error) // RemoveByTags removes all jobs that have at least one of the provided tags.