Merge branch 'add-url-builder-comment' into 'master'

Add comment to justify the use of a case statement

Closes #217397

See merge request gitlab-org/gitlab!31738

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