From 9149be29321d2532f019a4b485c58b9632d6f694 Mon Sep 17 00:00:00 2001 From: Mayur Kale Date: Mon, 24 Jun 2019 10:06:54 -0700 Subject: [PATCH] minor doc fix --- .../src/context/propagation/Propagation.ts | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/packages/opentelemetry-types/src/context/propagation/Propagation.ts b/packages/opentelemetry-types/src/context/propagation/Propagation.ts index 2b1dfcbb156..f47f54c09e5 100644 --- a/packages/opentelemetry-types/src/context/propagation/Propagation.ts +++ b/packages/opentelemetry-types/src/context/propagation/Propagation.ts @@ -16,22 +16,23 @@ import { SpanContext } from '../../trace/span_context'; +/** Defines a propagation interface. */ export interface Propagation { /** - * Injects the given SpanContext instance to transmit over the wire. + * Injects the given {@link SpanContext} instance to transmit over the wire. * * OpenTelemetry defines a common set of format values (BinaryFormat and - * HTTPTextFormat), and each has an expected carrier type. + * HTTPTextFormat), and each has an expected `carrier` type. * - * @param spanContext the SpanContext to transmit over the wire.. + * @param spanContext the SpanContext to transmit over the wire. * @param format the format of the carrier. * @param carrier the carrier of propagation fields, such as an http request. */ inject(spanContext: SpanContext, format: string, carrier: unknown): void; /** - * Returns a SpanContext instance extracted from carrier in the given - * format from upstream. + * Returns a {@link SpanContext} instance extracted from `carrier` in the + * given format from upstream. * * @param format the format of the carrier. * @param carrier the carrier of propagation fields, such as an http request.