Documentation(RuboCop): Add descriptions and examples to Scalability cops
-
Please check this box if this contribution uses AI-generated content (including content generated by GitLab Duo features) as outlined in the GitLab DCO & CLA. As a benefit of being a GitLab Community Contributor, you receive complimentary access to GitLab Duo.
What does this MR do and why?
Documentation(RuboCop): Add descriptions and examples to Scalability cops
Adds documentation comments and @example sections for the following
Scalability cops:
- BulkPerformWithContext
- CronWorkerContext
- FileUploads
- IdempotentWorker
- RandomCronSchedule
Also removes these cops from the exemption list in:
.rubocop_todo/internal_affairs/cop_description_with_example.yml
This improves RuboCop documentation coverage and resolves the following
issue:
References
Screenshots or screen recordings
| Before | After |
|---|---|
How to set up and validate locally
MR acceptance checklist
Evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.
Edited by Brian