lib/good_job/configuration.rb in good_job-1.4.0 vs lib/good_job/configuration.rb in good_job-1.4.1

@@ -99,9 +99,12 @@
         env['GOOD_JOB_POLL_INTERVAL'] ||
         DEFAULT_POLL_INTERVAL
       ).to_i
     end
 
+    # Number of seconds to preserve jobs when using the +good_job cleanup_preserved_jobs+ CLI command.
+    # This configuration is only used when {GoodJob.preserve_job_records} is +true+.
+    # @return [Boolean]
     def cleanup_preserved_jobs_before_seconds_ago
       (
         options[:before_seconds_ago] ||
         env['GOOD_JOB_CLEANUP_PRESERVED_JOBS_BEFORE_SECONDS_AGO'] ||
         DEFAULT_CLEANUP_PRESERVED_JOBS_BEFORE_SECONDS_AGO