Skip to content

Commit ad5483f

Browse files
Apply suggestions from code review
Co-authored-by: Alex Krawiec <[email protected]>
1 parent 0952050 commit ad5483f

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

docs/platforms/apple/common/configuration/options.mdx

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Note that setting this to `false` doesn't prevent all overhead from Sentry instr
3232

3333
<SdkOption name="debug" type="bool" defaultValue="false">
3434

35-
Turns debug mode on or off. If debug is enabled SDK will attempt to print out useful debugging information if something goes wrong with sending the event. It's generally not recommended to turn it on in production, though turning `debug` mode on will not cause any safety concerns.
35+
Turns debug mode on or off. If debug is enabled, SDK will attempt to print out useful debugging information if something goes wrong with sending the event. It's generally not recommended to turn it on in production, though this will not cause any safety concerns.
3636

3737
</SdkOption>
3838

@@ -121,7 +121,7 @@ When enabled, the SDK captures uncaught NSExceptions. As this feature uses swizz
121121

122122
This option registers the `NSApplicationCrashOnExceptions` UserDefault, so your macOS application crashes when an uncaught exception occurs. As the Cocoa Frameworks are generally not exception-safe on macOS, we recommend this approach because the application could otherwise end up in a corrupted state.
123123

124-
**Warning:** Don't use this in combination with `SentryCrashExceptionApplication`. Either enable this feature or use the `SentryCrashExceptionApplication`. Having both enabled can lead to duplicated reports.
124+
**Warning:** Don't use this in combination with `SentryCrashExceptionApplication`. Having both enabled can lead to duplicated reports.
125125

126126
This option is available as of SDK version 8.40.0. Learn more in the <PlatformLink to="/usage/#capturing-uncaught-exceptions">capturing uncaught exceptions</PlatformLink> documentation.
127127

@@ -238,9 +238,9 @@ The idle time, measured in ms, to wait until a <PlatformLink to="/tracing/instru
238238

239239
<SdkOption name="enableUIViewControllerTracing" type="bool" defaultValue="true">
240240

241-
When enabled, the SDK tracks performance for UIViewController subclasses.
241+
When enabled, the SDK tracks performance for the UIViewController subclasses.
242242

243-
This feature is not available in `DebugWithoutUIKit` and `ReleaseWithoutUIKit` configurations even when targeting iOS or tvOS platforms. Learn more in the <PlatformLink to="/tracing/instrumentation/automatic-instrumentation/#uiviewcontroller-tracing">UIViewController Tracing</PlatformLink> documentation.
243+
This feature is not available in `DebugWithoutUIKit` and `ReleaseWithoutUIKit` configurations, even when targeting iOS or tvOS platforms. Learn more in the <PlatformLink to="/tracing/instrumentation/automatic-instrumentation/#uiviewcontroller-tracing">UIViewController Tracing</PlatformLink> documentation.
244244

245245
</SdkOption>
246246

@@ -309,7 +309,7 @@ Learn more about structured logging in the <PlatformLink to="/logs/">logs docume
309309

310310
<SdkOption name="enableWatchdogTerminationTracking" type="bool" defaultValue="true">
311311

312-
When enabled, the SDK tracks watchdog terminations based on heuristics. This feature is available for iOS, tvOS, and Mac Catalyst, works only if the application was in the foreground, and doesn't track watchdog terminations for unit tests.
312+
When enabled, the SDK tracks watchdog terminations based on heuristics. This feature is available for iOS, tvOS, and Mac Catalyst. It only works if the application was in the foreground, and it doesn't track watchdog terminations for unit tests.
313313

314314
Learn more in the <PlatformLink to="/configuration/watchdog-terminations/">Watchdog Terminations</PlatformLink> documentation.
315315

@@ -364,7 +364,7 @@ The callback typically gets a second argument (called a "hint") which contains t
364364

365365
<SdkOption name="beforeSendSpan" type="function">
366366

367-
This function is called with a span object before it is sent to Sentry. You can return a modified span object, or `null` to skip sending the span. This can be used to filter or modify spans before they are sent.
367+
This function is called with a span object before it is sent to Sentry. You can return a modified span object, or `null`, to skip sending the span. This can be used to filter or modify spans before they are sent.
368368

369369
```swift {tabTitle:Swift}
370370
import Sentry
@@ -720,7 +720,7 @@ Learn more in the <PlatformLink to="/tracing/instrumentation/automatic-instrumen
720720
721721
<SdkOption name="enableTimeToFullDisplayTracing" type="bool" defaultValue="false">
722722
723-
When enabled, every UIViewController tracing transaction will wait for a call to `SentrySDK.reportFullyDisplayed()`. Use this in conjunction with `enableUIViewControllerTracing`. If `SentrySDK.reportFullyDisplayed()` is not called, the transaction will finish automatically after 30 seconds and the `Time to full display` span will be finished with `DeadlineExceeded` status.
723+
When enabled, every UIViewController tracing transaction will wait for a call to `SentrySDK.reportFullyDisplayed()`. Use this in conjunction with `enableUIViewControllerTracing`. If `SentrySDK.reportFullyDisplayed()` is not called, the transaction will finish automatically after 30 seconds and the `Time to full display` span will be finished with a `DeadlineExceeded` status.
724724
725725
Learn more in the <PlatformLink to="/tracing/instrumentation/automatic-instrumentation/#time-to-full-display">Time to Full Display</PlatformLink> documentation.
726726
@@ -742,15 +742,15 @@ Use a custom URLSession with your configuration for sending requests to Sentry.
742742
743743
<SdkOption name="enableSwizzling" type="bool" defaultValue="true">
744744
745-
Whether the SDK should use swizzling or not. When turned off the following features are disabled: breadcrumbs for touch events and navigation with UIViewControllers, automatic instrumentation for UIViewControllers, automatic instrumentation for HTTP requests, automatic instrumentation for file I/O with NSData, and automatically added sentry-trace header to HTTP requests for distributed tracing.
745+
Whether the SDK should use swizzling or not. When turned off, the following features are disabled: breadcrumbs for touch events and navigation with UIViewControllers, automatic instrumentation for UIViewControllers, automatic instrumentation for HTTP requests, automatic instrumentation for file I/O with NSData, and automatically added sentry-trace header to HTTP requests for distributed tracing.
746746
747747
Learn more in the <PlatformLink to="/configuration/swizzling/">Swizzling</PlatformLink> documentation.
748748
749749
</SdkOption>
750750
751751
<SdkOption name="swizzleClassNameExcludes" type="array" defaultValue="[]">
752752
753-
A set of class names to ignore for swizzling. The SDK checks if a class name of a class to swizzle contains a class name of this array. For example, if you add `MyUIViewController` to this list, the SDK excludes the following classes from swizzling: `YourApp.MyUIViewController`, `YourApp.MyUIViewControllerA`, `MyApp.MyUIViewController`.
753+
A set of class names to exclude from swizzling. The SDK checks whether the class’s name contains any value in this list. If it does, the class is skipped. For example, if you add `MyUIViewController` to this list, the SDK excludes the following classes from swizzling: `YourApp.MyUIViewController`, `YourApp.MyUIViewControllerA`, `MyApp.MyUIViewController`.
754754
755755
This option is available with SDK version 8.23.0 and above. Learn more in the <PlatformLink to="/configuration/swizzling/">Swizzling</PlatformLink> documentation.
756756
@@ -786,9 +786,9 @@ App Hang tracking is automatically disabled if a debugger is attached. Learn mor
786786
787787
<SdkOption name="appHangTimeoutInterval" type="double" defaultValue="2.0">
788788
789-
The minimum amount of time an app should be unresponsive to be classified as an App Hanging. The actual amount may be a little longer.
789+
The minimum amount of time an app should be unresponsive to be classified as an App Hang. The actual amount may be a little longer.
790790
791-
Avoid using values lower than 100ms, which may cause a lot of app hangs events being transmitted.
791+
Avoid using values below 100 ms, as this can result in a high volume of app hang events being sent.
792792
793793
Learn more in the <PlatformLink to="/configuration/app-hangs/">App Hangs</PlatformLink> documentation.
794794
@@ -834,15 +834,15 @@ Please also check the maximum attachment size of relay to make sure your attachm
834834
835835
<SdkOption name="reportAccessibilityIdentifier" type="bool" defaultValue="true">
836836
837-
If enabled, view hierarchy attachment will contain view `accessibilityIdentifier`. Set it to `false` if your project uses `accessibilityIdentifier` for PII.
837+
If enabled, the view hierarchy attachment will contain view `accessibilityIdentifier`. Set it to `false` if your project uses `accessibilityIdentifier` for PII.
838838
839839
</SdkOption>
840840
841841
<SdkOption name="swiftAsyncStacktraces" type="bool" defaultValue="false">
842842
843843
This feature is only available from Xcode 13 and from macOS 12.0, iOS 15.0, tvOS 15.0, watchOS 8.0.
844844
845-
This is an experimental feature and may still have bugs. When enabled, stitches the call to Swift Async functions in one consecutive stack trace.
845+
This is an experimental feature and may still have bugs. When enabled, the SDK stitches the call to Swift Async functions in one consecutive stack trace.
846846
847847
Learn more in the <PlatformLink to="/features/experimental-features/">Experimental Features</PlatformLink> documentation.
848848
@@ -852,7 +852,7 @@ Learn more in the <PlatformLink to="/features/experimental-features/">Experiment
852852
853853
The path where the SDK stores data (events, transactions, profiles, etc.). By default, the SDK uses `NSCachesDirectory`. You can specify a custom path if needed.
854854
855-
We recommend only changing this when the default, e.g., in security environments, can't be accessed.
855+
We recommend only changing this when the default can't be accessed, such as in security environments.
856856
857857
</SdkOption>
858858

0 commit comments

Comments
 (0)