Skip to content

Fix format_trace_id and format_span_id docstrings #4570

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 27, 2025
Merged

Fix format_trace_id and format_span_id docstrings #4570

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
51a87d0
update format_*_id docstrings
mattyding May 7, 2025
3f25e53
Merge branch 'main' into update-span-format-docstrings
mattyding May 24, 2025
e9c308a
Apply suggestions from code review
xrmx May 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions opentelemetry-api/src/opentelemetry/trace/span.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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")

Expand All @@ -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")
Loading