Clarify pre_shutdown_timeout behavior in new_kill_child comment

resque · Feb 22, 2017 · b619dc4 · b619dc4
1 parent 71a2764
commit b619dc4
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/lib/resque/worker.rb b/lib/resque/worker.rb
@@ -517,7 +517,9 @@ def start_heartbeat
 
     # Kills the forked child immediately with minimal remorse. The job it
     # is processing will not be completed. Send the child a TERM signal,
-    # wait 5 seconds, and then a KILL signal if it has not quit
+    # wait <term_timeout> seconds, and then a KILL signal if it has not quit
+    # If pre_shutdown_timeout has been set to a positive number, it will allow
+    # the child that many seconds before sending the aforementioned TERM and KILL.
     def new_kill_child
       if @child
         unless child_already_exited?