Add doc comment for untraced? in the concern

open-telemetry · Nov 22, 2023 · 64011e8 · 64011e8
1 parent 64ec771
commit 64011e8
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/instrumentation/excon/lib/opentelemetry/instrumentation/concerns/untraced_hosts.rb b/instrumentation/excon/lib/opentelemetry/instrumentation/concerns/untraced_hosts.rb
@@ -21,6 +21,9 @@ def self.included(klass)
           end
         end
 
+        # Checks whether the given host should be treated as untraced.
+        # If the current OpenTelemetry context is untraced, all hosts will be treated as untraced.
+        # The given host must be a String.
         def untraced?(host)
           OpenTelemetry::Common::Utilities.untraced? || untraced_host?(host)
         end