docs: add notes on attribute key descriptor (#155)

Co-authored-by: Valentin Marchaud <contact@vmarchaud.fr>
open-telemetry · Jan 25, 2022 · 1ed52fd · 1ed52fd
1 parent b125324
commit 1ed52fd
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/src/common/Attributes.ts b/src/common/Attributes.ts
@@ -16,6 +16,8 @@
 
 /**
  * Attributes is a map from string to attribute values.
+ *
+ * Note: only the own enumerable keys are counted as valid attribute keys.
  */
 export interface Attributes {
     [attributeKey: string]: AttributeValue | undefined;

diff --git a/src/trace/attributes.ts b/src/trace/attributes.ts
@@ -17,11 +17,11 @@
 import { Attributes, AttributeValue } from '../common/Attributes';
 
 /**
- * @deprecated please use Attributes
+ * @deprecated please use {@link Attributes}
  */
 export type SpanAttributes = Attributes;
 
 /**
- * @deprecated please use AttributeValue
+ * @deprecated please use {@link AttributeValue}
  */
 export type SpanAttributeValue = AttributeValue;