Clarify documentation of Gitlab::SidekiqStatus

The "running" state is ambiguous. Clarify that it covers both enqueued
and actually running jobs.

1 files changed, 3 insertions, 3 deletions

diff --git a/lib/gitlab/sidekiq_status.rb b/lib/gitlab/sidekiq_status.rb
index 583a970bf4e..0f890a12134 100644
--- a/lib/gitlab/sidekiq_status.rb
+++ b/lib/gitlab/sidekiq_status.rb
@@ -53,14 +53,14 @@ module Gitlab
       self.num_running(job_ids).zero?
     end
 
-    # Returns true if the given job is running
+    # Returns true if the given job is running or enqueued.
     #
     # job_id - The Sidekiq job ID to check.
     def self.running?(job_id)
       num_running([job_id]) > 0
     end
 
-    # Returns the number of jobs that are running.
+    # Returns the number of jobs that are running or enqueued.
     #
     # job_ids - The Sidekiq job IDs to check.
     def self.num_running(job_ids)
@@ -81,7 +81,7 @@ module Gitlab
     # job_ids - The Sidekiq job IDs to check.
     #
     # Returns an array of true or false indicating job completion.
-    # true = job is still running
+    # true = job is still running or enqueued
     # false = job completed
     def self.job_status(job_ids)
       keys = job_ids.map { |jid| key_for(jid) }