Document platform tracing params

rmosolgo · Jun 7, 2022 · f4d99f6 · f4d99f6
1 parent 073163b
commit f4d99f6
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/lib/graphql/tracing/platform_tracing.rb b/lib/graphql/tracing/platform_tracing.rb
@@ -115,6 +115,9 @@ def fallback_transaction_name(context)
       #
       # If the key isn't present, the given block is called and the result is cached for `key`.
       #
+      # @param ctx [GraphQL::Query::Context]
+      # @param key [Class, GraphQL::Field] A part of the schema
+      # @param trace_phase [Symbol] The stage of execution being traced (used by OpenTelementry tracing)
       # @return [String]
       def cached_platform_key(ctx, key, trace_phase)
         cache = ctx.namespace(self.class)[:platform_key_cache] ||= {}