Revise job configuration items for clarity

[Parth-Rewind]

Note:

• This will only apply to next release as the version 2.0.0 doesn't expose avg_job_duration or lost_job_threshold, while main branch does

Changes:

• Update the formatting for Scheduling based concurrency tuning section
• Add details for new config param max_delay for concurrency based throttling

Source of truth:

sidekiq-throttled/lib/sidekiq/throttled/strategy/concurrency.rb

Lines 26 to 40 in 854dffe

	# @param [#to_s] strategy_key
	# @param [#to_i, #call] limit Amount of allowed concurrent jobs
	# per processors running for given key.
	# @param [#to_i] avg_job_duration Average number of seconds needed
	# to complete a job of this type. Default: 300 or 1/3 of lost_job_threshold
	# @param [#to_i] lost_job_threshold Seconds to wait before considering
	# a job lost or dead. Default: 900 or 3 * avg_job_duration
	# @param [Proc] key_suffix Dynamic key suffix generator.
	# @param [#to_i] max_delay Maximum number of seconds to delay a job when it
	# throttled. This prevents jobs from being schedule very far in the future
	# when the backlog is large. Default: the smaller of 30 minutes or 10 * avg_job_duration
	# @deprecated @param [#to_i] ttl Obsolete alias for `lost_job_threshold`.
	# Default: 900 or 3 * avg_job_duration
	def initialize(strategy_key, limit:, avg_job_duration: nil, ttl: nil, # rubocop:disable Metrics/ParameterLists
	lost_job_threshold: ttl, key_suffix: nil, max_delay: nil)

Before

After

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.97%. Comparing base (854dffe) to head (1d0c83e).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #224   +/-   ##
=======================================
  Coverage   98.97%   98.97%           
=======================================
  Files          19       19           
  Lines         486      486           
  Branches       85       85           
=======================================
  Hits          481      481           
  Misses          5        5           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[ixti]

Thank you!!