Fix format_trace_id and format_span_id docstrings #4570
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The two docstrings I updated are incorrect and confused me while implementing otel spec. Per other docs, it looks like trace ID and span ID are intended to be 16-bytes and 8-bytes, respectively. The behavior of the
formatmethod in Python as implemented is to create a length N hexstring, which corresponds to N/2 bytes of data.Fixes # (issue)
Type of change
Please delete options that are not relevant.
I originally found this docstring by linking from the Python SDK documentation here
How Has This Been Tested?
N/A - documentation fix
Does This PR Require a Contrib Repo Change?
Checklist: