squash: add documentation

Author: arielvalentin

instrumentation/ethon/lib/opentelemetry/instrumentation/ethon/helpers.rb

@@ -11,6 +11,12 @@ module Ethon
       module Helpers
         extend self
 
+        # Formats the span name based on the HTTP method and URL template if available
+        #
+        # @param attributes [Hash] The span attributes hash
+        # @param http_method [String] The HTTP request method (e.g., 'GET', 'POST')
+        # @return [String] The formatted span name
+        # @api private
         def format_span_name(attributes, http_method)
           template = attributes['url.template']
           template ? "#{http_method} #{template}" : http_method

instrumentation/excon/lib/opentelemetry/instrumentation/excon/helpers.rb

@@ -11,6 +11,12 @@ module Excon
       module Helpers
         extend self
 
+        # Formats the span name based on the HTTP method and URL template if available
+        #
+        # @param attributes [Hash] The span attributes hash
+        # @param http_method [String] The HTTP request method (e.g., 'GET', 'POST')
+        # @return [String] The formatted span name
+        # @api private
         def format_span_name(attributes, http_method)
           template = attributes['url.template']
           template ? "#{http_method} #{template}" : http_method

instrumentation/faraday/lib/opentelemetry/instrumentation/faraday/helpers.rb

@@ -11,6 +11,12 @@ module Faraday
       module Helpers
         extend self
 
+        # Formats the span name based on the HTTP method and URL template if available
+        #
+        # @param attributes [Hash] The span attributes hash
+        # @param http_method [String] The HTTP request method (e.g., 'GET', 'POST')
+        # @return [String] The formatted span name
+        # @api private
         def format_span_name(attributes, http_method)
           template = attributes['url.template']
           template ? "#{http_method} #{template}" : http_method

instrumentation/http/lib/opentelemetry/instrumentation/http/helpers.rb

@@ -11,6 +11,12 @@ module HTTP
       module Helpers
         extend self
 
+        # Formats the span name based on the HTTP method and URL template if available
+        #
+        # @param attributes [Hash] The span attributes hash
+        # @param http_method [String] The HTTP request method (e.g., 'GET', 'POST')
+        # @return [String] The formatted span name
+        # @api private
         def format_span_name(attributes, http_method)
           template = attributes['url.template']
           template ? "#{http_method} #{template}" : http_method

instrumentation/http_client/lib/opentelemetry/instrumentation/http_client/helpers.rb

@@ -11,6 +11,12 @@ module HttpClient
       module Helpers
         extend self
 
+        # Formats the span name based on the HTTP method and URL template if available
+        #
+        # @param attributes [Hash] The span attributes hash
+        # @param http_method [String] The HTTP request method (e.g., 'GET', 'POST')
+        # @return [String] The formatted span name
+        # @api private
         def format_span_name(attributes, http_method)
           template = attributes['url.template']
           template ? "#{http_method} #{template}" : http_method

instrumentation/httpx/lib/opentelemetry/instrumentation/httpx/helpers.rb

@@ -11,6 +11,12 @@ module HTTPX
       module Helpers
         extend self
 
+        # Formats the span name based on the HTTP method and URL template if available
+        #
+        # @param attributes [Hash] The span attributes hash
+        # @param http_method [String] The HTTP request method (e.g., 'GET', 'POST')
+        # @return [String] The formatted span name
+        # @api private
         def format_span_name(attributes, http_method)
           template = attributes['url.template']
           template ? "#{http_method} #{template}" : http_method

instrumentation/net_http/lib/opentelemetry/instrumentation/net/http/helpers.rb

@@ -12,6 +12,12 @@ module HTTP
         module Helpers
           extend self
 
+          # Formats the span name based on the HTTP method and URL template if available
+          #
+          # @param attributes [Hash] The span attributes hash
+          # @param http_method [String] The HTTP request method (e.g., 'GET', 'POST')
+          # @return [String] The formatted span name
+          # @api private
           def format_span_name(attributes, http_method)
             template = attributes['url.template']
             template ? "#{http_method} #{template}" : http_method

instrumentation/restclient/lib/opentelemetry/instrumentation/restclient/helpers.rb

@@ -11,6 +11,12 @@ module RestClient
       module Helpers
         extend self
 
+        # Formats the span name based on the HTTP method and URL template if available
+        #
+        # @param attributes [Hash] The span attributes hash
+        # @param http_method [String] The HTTP request method (e.g., 'GET', 'POST')
+        # @return [String] The formatted span name
+        # @api private
         def format_span_name(attributes, http_method)
           template = attributes['url.template']
           template ? "#{http_method} #{template}" : http_method