Reword method comments

59bcb7b0 · Alex Kalderimis · b97743da · 59bcb7b0
Commit 59bcb7b0 authored Jan 27, 2021 by Alex Kalderimis
Hide whitespace changes
Inline Side-by-side

Showing with 4 additions and 2 deletions

app/graphql/types/packages/package_without_versions_type.rb app/graphql/types/packages/package_without_versions_type.rb +4 -2

No files found.
--- a/app/graphql/types/packages/package_without_versions_type.rb
+++ b/app/graphql/types/packages/package_without_versions_type.rb
@@ -27,8 +27,10 @@ module Types
        Gitlab::Graphql::Loaders::BatchModelLoader.new(Project, object.project_id).find
      end
-      # NOTE: This method must be kept in sync with `MetadataType.resolve_type`.
+      # NOTE: This method must be kept in sync with the union
-      # This method must never produce data that the discriminator cannot handle.
+      # type: `Types::Packages::MetadataType`.
+      #
+      # `Types::Packages::MetadataType.resolve_type(metadata, ctx)` must never raise.
      def metadata
        case object.package_type
        when 'composer'