Docs/fix-trace-config-docstring#5025
Open
samyak1729 wants to merge 2 commits intoopen-telemetry:mainfrom
Open
Conversation
The trace_config parameter was unused. Originally intended for trace-level configuration from the OpenTelemetry protocol, but the upstream TraceConfig proto was removed. Retained for backwards compatibility.
1cfaee6 to
c4e20a1
Compare
tammy-baylis-swi
approved these changes
Mar 31, 2026
emdneto
approved these changes
Mar 31, 2026
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
Document the unused
trace_configparameter inSpan.__init__.This parameter was introduced in the very first span implementation (PR #69) as a
placeholder for the
TraceConfigprotobuf message. The upstream OpenTelemetry protocolremoved
TraceConfigin proto v0.20, and the parameter was never wired up, it isonly assigned to
self._trace_configwhich is never read anywhere in the codebase.The parameter is retained for backwards compatibility, as external code may be
passing it.
Fixes # (issue)
Type of change
How Has This Been Tested?
This is a docstring-only change with no behavioral impact. The existing test suite
passes without modification.
Does This PR Require a Contrib Repo Change?
Checklist: