Fix format_trace_id and format_span_id docstrings (open-telemetry#4570)

mattyding · xrmx · emdneto · web-flow · commit 6ea3c0f11a28 · 2025-05-27T12:34:51.000Z
* update format_*_id docstrings

* Apply suggestions from code review

Co-authored-by: Emídio Neto &lt;9735060+emdneto@users.noreply.github.com&gt;

---------

Co-authored-by: Riccardo Magliocchetti &lt;riccardo.magliocchetti@gmail.com&gt;
Co-authored-by: Emídio Neto &lt;9735060+emdneto@users.noreply.github.com&gt;
diff --git a/opentelemetry-api/src/opentelemetry/trace/span.py b/opentelemetry-api/src/opentelemetry/trace/span.py
@@ -592,7 +592,7 @@ def format_trace_id(trace_id: int) -> str:
         trace_id: Trace ID int
 
     Returns:
-        The trace ID as 32-byte hexadecimal string
+        The trace ID (16 bytes) cast to a 32-character hexadecimal string
     """
     return format(trace_id, "032x")
 
@@ -603,6 +603,6 @@ def format_span_id(span_id: int) -> str:
         span_id: Span ID int
 
     Returns:
-        The span ID as 16-byte hexadecimal string
+        The span ID (8 bytes) cast to a 16-character hexadecimal string
     """
     return format(span_id, "016x")
