From 96fe017828db7425a79cc64f5f2e8cd0bc0b08de Mon Sep 17 00:00:00 2001
From: John Roesler <johnrroesler@gmail.com>
Date: Thu, 23 Jan 2025 14:09:03 -0600
Subject: [PATCH] clarify context docs

---
 example_test.go | 8 ++++----
 job.go          | 8 ++++----
 scheduler.go    | 4 ++--
 3 files changed, 10 insertions(+), 10 deletions(-)

diff --git a/example_test.go b/example_test.go
index ac6efbd..2c9cf85 100644
--- a/example_test.go
+++ b/example_test.go
@@ -362,8 +362,8 @@ func ExampleNewTask() {
 		gocron.DurationJob(time.Second),
 		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 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.
 			},
 		),
@@ -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 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.
 			},
 		),
diff --git a/job.go b/job.go
index a543a44..dd5398f 100644
--- a/job.go
+++ b/job.go
@@ -84,8 +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 (either the default Job context, or one provided via WithContext)
-// to the job and will cancel the context 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 {
@@ -710,8 +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 (either the default Job context, or one provided via WithContext)
-// to the job and will cancel the context 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 112870f..63f353c 100644
--- a/scheduler.go
+++ b/scheduler.go
@@ -22,8 +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 (either the default Job context, or one provided via WithContext)
-	// to the job and will cancel the context 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.