Skip to content

Commit 2ced45d

Browse files
committed
jsdoc update
1 parent 162003e commit 2ced45d

File tree

2 files changed

+2
-5
lines changed

2 files changed

+2
-5
lines changed

packages/core/src/types-hoist/span.ts

+1-4
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.

packages/opentelemetry/src/utils/parseSpanDescription.ts

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

0 commit comments

Comments
 (0)