From 9761a44930711290243fe862c8cc2cdaa751bee8 Mon Sep 17 00:00:00 2001 From: Mohammed Sohail Date: Wed, 16 Oct 2024 12:04:37 +0300 Subject: [PATCH 1/2] docs: update MaxWorkers behaviour as it propagates down to the producer refs: *https://github.com/riverqueue/river/blob/master/producer.go#L598 I think this makes it clear on how the max workers value should be tuned based on the job type. --- client.go | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/client.go b/client.go index 6e4e3a0c..2f5877e8 100644 --- a/client.go +++ b/client.go @@ -309,7 +309,8 @@ func (c *Config) willExecuteJobs() bool { // QueueConfig contains queue-specific configuration. type QueueConfig struct { // MaxWorkers is the maximum number of workers to run for the queue, or put - // otherwise, the maximum parallelism to run. + // otherwise, the the upper limit on the number of executor goroutines that + // will be spawned for the queue, not counting workers already processing jobs. // // This is the maximum number of workers within this particular client // instance, but note that it doesn't control the total number of workers From 521a67050dcf2100b80f5e172736c90b1c9602f1 Mon Sep 17 00:00:00 2001 From: Mohammed Sohail Date: Wed, 16 Oct 2024 12:08:58 +0300 Subject: [PATCH 2/2] docs (fix): linter suggestions --- client.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/client.go b/client.go index 2f5877e8..9be86c2d 100644 --- a/client.go +++ b/client.go @@ -309,7 +309,7 @@ func (c *Config) willExecuteJobs() bool { // QueueConfig contains queue-specific configuration. type QueueConfig struct { // MaxWorkers is the maximum number of workers to run for the queue, or put - // otherwise, the the upper limit on the number of executor goroutines that + // otherwise, the upper limit on the number of executor goroutines that // will be spawned for the queue, not counting workers already processing jobs. // // This is the maximum number of workers within this particular client