From 60ff5e89c820b7880db29ae0951eec1b6890b519 Mon Sep 17 00:00:00 2001 From: Matthew Macdonald-Wallace Date: Tue, 16 Apr 2024 17:52:52 +0100 Subject: [PATCH] Improve documentation for trace.propagator.inject() (#3850) --- opentelemetry-api/src/opentelemetry/propagate/__init__.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/opentelemetry-api/src/opentelemetry/propagate/__init__.py b/opentelemetry-api/src/opentelemetry/propagate/__init__.py index 90f9e61744..a7006175fb 100644 --- a/opentelemetry-api/src/opentelemetry/propagate/__init__.py +++ b/opentelemetry-api/src/opentelemetry/propagate/__init__.py @@ -109,8 +109,9 @@ def inject( """Uses the configured propagator to inject a Context into the carrier. Args: - carrier: An object that contains a representation of HTTP - headers. Should be paired with setter, which + carrier: the medium used by Propagators to read + values from and write values to. + Should be paired with setter, which should know how to set header values on the carrier. context: An optional Context to use. Defaults to current context if not set.