Review feedback

Author: jamescrosswell

CHANGELOG.md

@@ -5,7 +5,8 @@
 ### BREAKING CHANGES
 
 - SentryOptions.IsEnvironmentUser now defaults to false on MAUI. The means the User.Name will no longer be set, by default, to the name of the device ([#4606](https://github.com/getsentry/sentry-dotnet/pull/4606))
-- Spans and Transactions now implement `IDispose` so that they can be used with `using` statements that will automatically finish the span when it passes out of scope, to be consistent with `Activity` classes when using OpenTelemetry ([#4627](https://github.com/getsentry/sentry-dotnet/pull/4627))
+- Spans and Transactions now implement `IDispose` so that they can be used with `using` statements/declarations that will automatically finish the span with a status of OK when it passes out of scope, if it has not already been finished, to be consistent with `Activity` classes when using OpenTelemetry ([#4627](https://github.com/getsentry/sentry-dotnet/pull/4627))
+- SpanTracer and TransactionTracer are still public but these are now `sealed` (see also [#4627](https://github.com/getsentry/sentry-dotnet/pull/4627))
 - Remove unnecessary files from SentryCocoaFramework before packing ([#4602](https://github.com/getsentry/sentry-dotnet/pull/4602))
 
 ### Fixes

src/Sentry/TransactionTracer.cs

@@ -440,9 +440,15 @@ private void ReleaseSpans()
     }
 
     /// <summary>
-    /// Automatically finishes the span at the end of a <c>using</c> block. This is a convenience method only. Disposing
-    /// is not required (and analyser warnings are suppressed).
+    /// <para>
+    /// Automatically finishes the transaction with a status of <see cref="SpanStatus.Ok" /> at the end of a
+    /// <c>using</c> block, if it has not already been finished.
+    /// </para>
+    /// <para>
+    /// This is the equivalent of calling <see cref="Finish()" /> when the transaction passes out of scope.
+    /// </para>
     /// </summary>
+    /// <remarks>This is a convenience method only. Disposing is not required.</remarks>
     public void Dispose()
     {
         Finish();

test/Sentry.Tests/SpanTracerTests.cs

@@ -41,7 +41,7 @@ public async Task SetExtra_DataInserted_NoDataLoss()
     }
 
     [Fact]
-    public void Dispose_Finished_Finishes()
+    public void Dispose_TransactionIsUnfinished_FinishesTransaction()
     {
         // Arrange
         var hub = Substitute.For<IHub>();
@@ -55,7 +55,7 @@ public void Dispose_Finished_Finishes()
     }
 
     [Fact]
-    public void Dispose_Unfinished_DoesNothing()
+    public void Dispose_TransactionIsFinsished_DoesNothing()
     {
         // Arrange
         var hub = Substitute.For<IHub>();