Skip to content

Commit 2ed0509

Browse files
committed
jsdoc update
1 parent a37c1ae commit 2ed0509

File tree

2 files changed

+2
-5
lines changed

2 files changed

+2
-5
lines changed

packages/opentelemetry/src/utils/parseSpanDescription.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,7 @@ export function getSanitizedUrl(
267267
* Because Otel decided to mutate span names via `span.updateName`, the only way to ensure
268268
* that a user-set span name is preserved is to store it as a tmp attribute on the span.
269269
* We delete this attribute once we're done with it when preparing the event envelope.
270-
* @internal
270+
* @internal exported only for testing
271271
*/
272272
export function getOriginalName(name: string, attributes: Attributes): string {
273273
return attributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] === 'custom' &&

packages/types/src/span.ts

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -241,10 +241,7 @@ export interface Span {
241241
* the final name of the span. Instrumentation might still overwrite the name with an automatically
242242
* computed name, for example in `http.server` or `db` spans.
243243
*
244-
* You can ensure that your name is kept and not overwritten by
245-
* - either calling `Sentry.updateSpanName(span, name)`
246-
* - or by calling `span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, 'custom')`
247-
* in addition to `span.updateName`.
244+
* You can ensure that your name is kept and not overwritten by calling `Sentry.updateSpanName(span, name)`
248245
*
249246
* If you want to update a span name in a browser-only app, `span.updateName` and `Sentry.updateSpanName`
250247
* are identical: In both cases, the name will not be overwritten by the Sentry SDK.

0 commit comments

Comments
 (0)