chore: add method comments

open-telemetry · May 8, 2024 · 164ddc4 · 164ddc4
1 parent 18e4fa3
commit 164ddc4
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/common/lib/opentelemetry/common/utilities.rb b/common/lib/opentelemetry/common/utilities.rb
@@ -86,7 +86,11 @@ def truncate_attribute_value(value, limit)
         end
       end
 
-      # Disables tracing within the provided block.
+      # Disables tracing within the provided block
+      # If no block is provided instead returns an
+      # untraced ctx.
+      #
+      # @param [optional Context] context Accepts an explicit context, defaults to current
       def untraced(context = Context.current)
         context = context.set_value(UNTRACED_KEY, true)
         if block_given?