Skip to content

Attempt to clarify docs how to use LimitedCapacity::Worker

Dylan Griffith requested to merge improve-docs-for-limited-capacity-worker into master

What does this MR do and why?

The previous documentation said "a cron worker must be defined as well" which did not seem to be correct as some of these workers aren't queued this way. Additionally the previous example didn't make sense because cron workers don't get passed arguments.

I've also opted to remove the duplicated docs example from the class for a single source of truth. I also like the docs in the Ruby code to make it clearer to the reader but the risk of getting out of sync with the primary documentation (and the fact that it was currently confusing) seemed like it wasn't worth keeping.

Screenshots or screen recordings

Screenshots are required for UI changes, and strongly recommended for all other merge requests.

Before After

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Merge request reports