Skip to content
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.

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

Improve documentation for trace.propagator.inject() #3850

Merged
merged 3 commits into from
Apr 16, 2024

Conversation

proffalken
Copy link
Contributor

@proffalken proffalken commented Apr 15, 2024

Description

At present, the documentation suggests that HTTP Headers are the only appropriate carrier, when any object is fine including a standard dict.

This PR updates the wording to make clear it is more generic.

Type of change

Please delete options that are not relevant.

  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

N/A - Documentation change

Does This PR Require a Contrib Repo Change?

Answer the following question based on these examples of changes that would require a Contrib Repo Change:

  • The OTel specification has changed which prompted this PR to update the method interfaces of opentelemetry-api/ or opentelemetry-sdk/

  • The method interfaces of test/util have changed

  • Scripts in scripts/ that were copied over to the Contrib repo have changed

  • Configuration files that were copied over to the Contrib repo have changed (when consistency between repositories is applicable) such as in

    • pyproject.toml
    • isort.cfg
    • .flake8
  • When a new .github/CODEOWNER is added

  • Major changes to project information, such as in:

    • README.md
    • CONTRIBUTING.md
  • Yes. - Link to PR:

  • No.

Checklist:

  • Documentation has been updated

At present, the documentation suggests that HTTP Headers are the only appropriate carrier, when any object is fine including a standard dict.

This PR updates the wording to make clear it is more generic.
@proffalken proffalken requested a review from a team April 15, 2024 14:38
Copy link

linux-foundation-easycla bot commented Apr 15, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: lzchen / name: Leighton Chen (9f50ced)
  • ✅ login: proffalken / name: Matthew Macdonald-Wallace (da2a57d, 00e8230)

@lzchen lzchen added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Apr 16, 2024
@lzchen lzchen merged commit 60ff5e8 into open-telemetry:main Apr 16, 2024
234 of 235 checks passed
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
None yet
Development

Successfully merging this pull request may close these issues.

4 participants