Skip to content

Fix shim docstring example#5077

Merged
xrmx merged 6 commits into
open-telemetry:mainfrom
Manvi2402:fix-shim-docstring-example
Apr 20, 2026
Merged

Fix shim docstring example#5077
xrmx merged 6 commits into
open-telemetry:mainfrom
Manvi2402:fix-shim-docstring-example

Conversation

@Manvi2402

Copy link
Copy Markdown
Contributor

Description

Fix incorrect code example in create_tracer() docstring.

The docstring example was passing a Tracer object to create_tracer(),
but it expects a TracerProvider object.

Fixes #5072

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

No tests required — this is a documentation-only fix (docstring example).
Existing test in test_shim.py:46 already validates correct usage.

Does This PR Require a Contrib Repo Change?

  • Yes. - Link to PR:
  • No.

Checklist:

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

Comment thread CHANGELOG.md Outdated
@github-project-automation github-project-automation Bot moved this to Approved PRs in Python PR digest Apr 10, 2026
@xrmx
xrmx enabled auto-merge (squash) April 20, 2026 13:52
@xrmx
xrmx merged commit 3ba556f into open-telemetry:main Apr 20, 2026
466 checks passed
@github-project-automation github-project-automation Bot moved this from Approved PRs to Done in Python PR digest Apr 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

Incorrect shim code example

4 participants