open-telemetry / opentelemetry-python

OpenTelemetry Python API and SDK
https://opentelemetry.io
Apache License 2.0
1.76k stars 614 forks source link

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

Closed proffalken closed 5 months ago

proffalken commented 5 months ago

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.

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:

Checklist:

linux-foundation-easycla[bot] commented 5 months ago

CLA Signed

The committers listed above are authorized under a signed CLA.