From b578da33e7a3b63253b53816e8bef106d8e30dd6 Mon Sep 17 00:00:00 2001 From: Brandur Date: Sat, 27 Sep 2025 09:11:41 -0700 Subject: [PATCH] Minor grammar fix on `Pilot.JobCleanerQueuesExcluded` There was an extra word before ("as") that made this doc's grammar wrong, but it was also just written in such a way that it was difficult to parse. Here, do a bit of a rewrite as a fix up. --- rivershared/riverpilot/pilot.go | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/rivershared/riverpilot/pilot.go b/rivershared/riverpilot/pilot.go index cf41be81..ea0aff6b 100644 --- a/rivershared/riverpilot/pilot.go +++ b/rivershared/riverpilot/pilot.go @@ -20,8 +20,10 @@ type Pilot interface { PilotPeriodicJob // JobCleanerQueuesExcluded returns queues that should be excluded from the - // main River client's JobCleaner. Empty omitted queues should return nil as - // instead of empty array. + // main River client's JobCleaner. If no queues should be omitted, this + // function should return nil as opposed to an empty array. (Because the + // underlying database query uses an `IS NULL` check, though this could + // conceivably be changed.) JobCleanerQueuesExcluded() []string JobGetAvailable(