better DisableAppDomainProcessExitFlush docs (#1634)

getsentry · May 3, 2022 · 1f5868a · 1f5868a
1 parent e15413f
commit 1f5868a
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,6 +15,7 @@
 - Demystify stack traces for exceptions that fire in a `BeforeSend` callback. ([#1587](https://github.com/getsentry/sentry-dotnet/pull/1587))
 - Obsolete `Platform` and always write `csharp` ([#1610](https://github.com/getsentry/sentry-dotnet/pull/1610))
 - Fix a minor issue in the caching transport related to recovery of files from previous session. ([#1617](https://github.com/getsentry/sentry-dotnet/pull/1617))
+- Better DisableAppDomainProcessExitFlush docs ([#1634](https://github.com/getsentry/sentry-dotnet/pull/1634))
 
 ## 3.16.0
 

diff --git a/src/Sentry/SentryOptionsExtensions.cs b/src/Sentry/SentryOptionsExtensions.cs
@@ -74,7 +74,8 @@ public static void DisableNetFxInstallationsIntegration(this SentryOptions optio
 #endif
 
         /// <summary>
-        /// Disables the capture of errors through <see cref="AppDomain.ProcessExit"/>
+        /// By default, any queued events (i.e: captures errors) are flushed on <see cref="AppDomain.ProcessExit"/>.
+        /// This method disables that behaviour.
         /// </summary>
         /// <param name="options">The SentryOptions to remove the integration from.</param>
         public static void DisableAppDomainProcessExitFlush(this SentryOptions options) =>