From 164ddc4a6b3cafc1b59f77609e97c80fecf4c0b2 Mon Sep 17 00:00:00 2001 From: Robert Laurin Date: Wed, 8 May 2024 10:29:23 -0500 Subject: [PATCH] chore: add method comments --- common/lib/opentelemetry/common/utilities.rb | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/common/lib/opentelemetry/common/utilities.rb b/common/lib/opentelemetry/common/utilities.rb index df5872239..7add19259 100644 --- 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?