ref: Make description in SpanProtocol nonnull

SentrySpanProtocol.startChildWithOperation has an overload without a description if you don't want to specify a description. We don't need the description to be nullable.
getsentry · Apr 20, 2021 · b370a21 · b370a21
1 parent 64cd981
commit b370a21
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 16 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## unreleased
+
+- ref: Make description in SpanProtocol nonnull #1059
+
 ## 7.0.0-beta.0
 
 - feat: Add close method to SDK #1046

diff --git a/Sources/Sentry/Public/SentrySpanProtocol.h b/Sources/Sentry/Public/SentrySpanProtocol.h
@@ -53,7 +53,7 @@ NS_SWIFT_NAME(Span)
  * @return SentrySpan
  */
 - (id<SentrySpan>)startChildWithOperation:(NSString *)operation
-                              description:(nullable NSString *)description
+                              description:(NSString *)description
     NS_SWIFT_NAME(startChild(operation:description:));
 
 /**

diff --git a/Sources/Sentry/SentrySpan.m b/Sources/Sentry/SentrySpan.m
@@ -37,11 +37,16 @@ - (instancetype)initWithContext:(SentrySpanContext *)context
 
 - (id<SentrySpan>)startChildWithOperation:(NSString *)operation
 {
-    return [self startChildWithOperation:operation description:nil];
+    return [self startChildWithOperationInternal:operation description:nil];
 }
 
-- (id<SentrySpan>)startChildWithOperation:(NSString *)operation
-                              description:(nullable NSString *)description
+- (id<SentrySpan>)startChildWithOperation:(NSString *)operation description:(NSString *)description
+{
+    return [self startChildWithOperationInternal:operation description:description];
+}
+
+- (id<SentrySpan>)startChildWithOperationInternal:(NSString *)operation
+                                      description:(nullable NSString *)description
 {
     return [self.tracer startChildWithParentId:[self.context spanId]
                                      operation:operation

diff --git a/Sources/Sentry/include/SentrySpan.h b/Sources/Sentry/include/SentrySpan.h
@@ -66,18 +66,6 @@ SENTRY_NO_INIT
 - (id<SentrySpan>)startChildWithOperation:(NSString *)operation
     NS_SWIFT_NAME(startChild(operation:));
 
-/**
- * Starts a child span.
- *
- * @param operation Defines the child span operation.
- * @param description Define the child span description.
- *
- * @return SentrySpan
- */
-- (id<SentrySpan>)startChildWithOperation:(NSString *)operation
-                              description:(nullable NSString *)description
-    NS_SWIFT_NAME(startChild(operation:description:));
-
 /**
  * Sets an extra.
  */