Skip to content

Docs/fix-trace-config-docstring#5025

Merged
xrmx merged 4 commits intoopen-telemetry:mainfrom
samyak1729:docs/fix-trace-config-docstring
Apr 3, 2026
Merged

Docs/fix-trace-config-docstring#5025
xrmx merged 4 commits intoopen-telemetry:mainfrom
samyak1729:docs/fix-trace-config-docstring

Conversation

@samyak1729
Copy link
Copy Markdown
Contributor

Description

Document the unused trace_config parameter in Span.__init__.

This parameter was introduced in the very first span implementation (PR #69) as a
placeholder for the TraceConfig protobuf message. The upstream OpenTelemetry protocol
removed TraceConfig in proto v0.20, and the parameter was never wired up, it is
only assigned to self._trace_config which 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

  • This change requires a documentation update

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?

  • No.

Checklist:

  • Followed the style guidelines of this project
  • Changelogs have been updated
  • Unit tests have been added
  • Documentation has been updated

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.
@samyak1729 samyak1729 force-pushed the docs/fix-trace-config-docstring branch from 1cfaee6 to c4e20a1 Compare March 31, 2026 07:20
@lzchen lzchen added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Mar 31, 2026
@tammy-baylis-swi tammy-baylis-swi moved this to Easy to review / merge / close in Python PR digest Mar 31, 2026
@tammy-baylis-swi tammy-baylis-swi requested a review from a team March 31, 2026 17:02
@xrmx xrmx enabled auto-merge (squash) April 3, 2026 14:10
@xrmx xrmx merged commit c932eb8 into open-telemetry:main Apr 3, 2026
507 checks passed
@github-project-automation github-project-automation Bot moved this from Easy to review / merge / close to Done in Python PR digest Apr 3, 2026
Vitexus pushed a commit to Vitexus/opentelemetry-python that referenced this pull request Apr 30, 2026
…y#5025)

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.

Co-authored-by: Leighton Chen <lechen@microsoft.com>
Co-authored-by: Emídio Neto <9735060+emdneto@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Skip Changelog PRs that do not require a CHANGELOG.md entry

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

5 participants