Add comment to justify the use of a case statement

e8a7ac80 · Markus Koller · 790793d9 · e8a7ac80
Commit e8a7ac80 authored May 12, 2020 by Markus Koller
Hide whitespace changes
Inline Side-by-side

Showing with 3 additions and 0 deletions

lib/gitlab/url_builder.rb lib/gitlab/url_builder.rb +3 -0

No files found.
--- a/lib/gitlab/url_builder.rb
+++ b/lib/gitlab/url_builder.rb
@@ -11,6 +11,9 @@ module Gitlab
    class << self
      include ActionView::RecordIdentifier
+      # Using a case statement here is preferable for readability and maintainability.
+      # See discussion in https://gitlab.com/gitlab-org/gitlab/-/issues/217397
+      #
      # rubocop:disable Metrics/CyclomaticComplexity
      def build(object, **options)
        # Objects are sometimes wrapped in a BatchLoader instance