Skip to content

Commit 22a8901

Browse files
committed
further jsdoc adjustments
1 parent 64b5848 commit 22a8901

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

packages/core/src/scope.ts

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -306,8 +306,12 @@ export class Scope {
306306
/**
307307
* Sets attributes onto the scope.
308308
*
309-
* TODO:
310-
* Currently, these attributes are not applied to any telemetry data but they will be in the future.
309+
* These attributes are currently only applied to logs.
310+
* In the future, they will also be applied to metrics and spans.
311+
*
312+
* Important: For now, only strings, numbers and boolean attributes are supported, despite types allowing for
313+
* more complex attribute types. We'll add this support in the future but already specify the wider type to
314+
* avoid a breaking change in the future.
311315
*
312316
* @param newAttributes - The attributes to set on the scope. You can either pass in key-value pairs, or
313317
* an object with a `value` and an optional `unit` (if applicable to your attribute).
@@ -317,7 +321,6 @@ export class Scope {
317321
* scope.setAttributes({
318322
* is_admin: true,
319323
* payment_selection: 'credit_card',
320-
* clicked_products: [130, 554, 292],
321324
* render_duration: { value: 'render_duration', unit: 'ms' },
322325
* });
323326
* ```

0 commit comments

Comments
 (0)