@@ -6,25 +6,25 @@ type Pool interface {
66 // Queue queues the work to be run, and starts processing immediately
77 Queue (fn WorkFunc ) WorkUnit
88
9- // Reset reinitializes a pool that has been closed/cancelled back to a working state.
10- // if the pool has not been closed/cancelled, nothing happens as the pool is still in
11- // a valid running state
9+ // Reset reinitializes a pool that has been closed/cancelled back to a working
10+ // state. if the pool has not been closed/cancelled, nothing happens as the pool
11+ // is still in a valid running state
1212 Reset ()
1313
14- // Cancel cancels any pending work still not committed to processing
15- // call Reset() to reinitialize the pool for use.
14+ // Cancel cancels any pending work still not committed to processing.
15+ // Call Reset() to reinitialize the pool for use.
1616 Cancel ()
1717
18- // Close cleans up pool data and cancels any pending work still not committed to processing
19- // call Reset() to reinitialize the pool for use.
18+ // Close cleans up pool data and cancels any pending work still not committed
19+ // to processing. Call Reset() to reinitialize the pool for use.
2020 Close ()
2121
22- // Batch creates a new Batch object for queueing Work Units separate from any others
23- // that may be running on the pool. Grouping these Work Units together allows for individual
24- // Cancellation of the Batch Work Units without affecting anything else running on the pool
25- // as well as outputting the results on a channel as they complete.
26- // NOTE: Batch is not reusable, once QueueComplete() has been called it's lifetime has been sealed
27- // to completing the Queued items.
22+ // Batch creates a new Batch object for queueing Work Units separate from any
23+ // others that may be running on the pool. Grouping these Work Units together
24+ // allows for individual Cancellation of the Batch Work Units without affecting
25+ // anything else running on the pool as well as outputting the results on a
26+ // channel as they complete. NOTE: Batch is not reusable, once QueueComplete()
27+ // has been called it's lifetime has been sealed to completing the Queued items.
2828 Batch () Batch
2929}
3030
0 commit comments