diff options
Diffstat (limited to 'app/finders/README.md')
| -rw-r--r-- | app/finders/README.md | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/app/finders/README.md b/app/finders/README.md index 1a1c69dea38..52f7378c484 100644 --- a/app/finders/README.md +++ b/app/finders/README.md @@ -1,10 +1,11 @@ # Finders -This type of classes responsible for collection items based on different conditions. -To prevent lookup methods in models like this: +These types of classes are responsible for retrieving collection items based on different conditions. +They prevent lookup methods in models like this: + ```ruby -class Project +class Project < ApplicationRecord def issues_for_user_filtered_by(user, filter) # A lot of logic not related to project model itself end @@ -13,10 +14,10 @@ end issues = project.issues_for_user_filtered_by(user, params) ``` -Better use this: +The GitLab approach is to use a Finder: ```ruby issues = IssuesFinder.new(project, user, filter).execute ``` -It will help keep models thiner. +It will help keep models thinner. |