Skip to content

Commit

Permalink
clarify context docs
Browse files Browse the repository at this point in the history
  • Loading branch information
JohnRoesler committed Jan 23, 2025
1 parent 96fe017 commit 6133a24
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
4 changes: 2 additions & 2 deletions example_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -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.
},
),
Expand Down
9 changes: 5 additions & 4 deletions job.go
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down

0 comments on commit 6133a24

Please sign in to comment.