chore: make tsdocs more clear

open-telemetry · Jun 4, 2021 · a77713d · a77713d
1 parent e15c874
commit a77713d
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 3 deletions.
diff --git a/packages/opentelemetry-context-async-hooks/src/AbstractAsyncHooksContextManager.ts b/packages/opentelemetry-context-async-hooks/src/AbstractAsyncHooksContextManager.ts
@@ -51,6 +51,12 @@ export abstract class AbstractAsyncHooksContextManager
 
   abstract disable(): this;
 
+  /**
+   * Binds a the certain context or the active one to the target function and then returns the target
+   * @param context A context (span) to be bind to target
+   * @param target a function or event emitter. When target or one of its callbacks is called,
+   *  the provided context will be used as the active context for the duration of the call.
+   */
   bind<T>(context: Context, target: T): T {
     if (target instanceof EventEmitter) {
       return this._bindEventEmitter(target, context);

diff --git a/packages/opentelemetry-context-zone-peer-dep/src/ZoneContextManager.ts b/packages/opentelemetry-context-zone-peer-dep/src/ZoneContextManager.ts
@@ -202,8 +202,9 @@ export class ZoneContextManager implements ContextManager {
 
   /**
    * Binds a the certain context or the active one to the target function and then returns the target
-   * @param target
    * @param context A context (span) to be bind to target
+   * @param target a function or event emitter. When target or one of its callbacks is called,
+   *  the provided context will be used as the active context for the duration of the call.
    */
   bind<T>(context: Context, target: T | TargetWithEvents): T {
     // if no specific context to propagate is given, we use the current one

diff --git a/packages/opentelemetry-web/src/StackContextManager.ts b/packages/opentelemetry-web/src/StackContextManager.ts
@@ -62,8 +62,9 @@ export class StackContextManager implements ContextManager {
 
   /**
    * Binds a the certain context or the active one to the target function and then returns the target
-   * @param target
-   * @param context
+   * @param context A context (span) to be bind to target
+   * @param target a function or event emitter. When target or one of its callbacks is called,
+   *  the provided context will be used as the active context for the duration of the call.
    */
   bind<T>(context: Context, target: T): T {
     // if no specific context to propagate is given, we use the current one