Apply suggestions from code review

onurtemizkan · imatwawana · web-flow · commit a94f8fd37051 · 2022-11-11T12:00:19.000Z
Co-authored-by: Isabel &lt;76437239+imatwawana@users.noreply.github.com&gt;
diff --git a/src/platform-includes/capture-error/node.mdx b/src/platform-includes/capture-error/node.mdx
@@ -1,4 +1,4 @@
-You can pass an `Error` object to `captureException()` to get it captured as event. It's also possible to pass non-Error objects and strings, but be aware that the resulting events in Sentry may be missing a stacktrace.
+You can pass an `Error` object to `captureException()` to have it captured as event. It's also possible to pass non-`Error` objects and strings, but be aware that the resulting events in Sentry may be missing a stack trace.
 
 ```javascript
 import * as Sentry from '@sentry/node';
diff --git a/src/platform-includes/configuration/breadcrumb-hints/_default.mdx b/src/platform-includes/configuration/breadcrumb-hints/_default.mdx
@@ -1,6 +1,6 @@
 `event`
 
-: For breadcrumbs created from browser events, the Sentry SDK often supplies the event to the breadcrumb as a hint. This, for instance, can be used to extract data from the target DOM element into a breadcrumb.
+: For breadcrumbs created from browser events, the Sentry SDK often supplies the event to the breadcrumb as a hint. This can be used to extract data from the target DOM element into a breadcrumb, for example.
 
 `level` / `input`
 
@@ -16,4 +16,4 @@
 
 `xhr`
 
-: For breadcrumbs created from HTTP requests done via the legacy `XMLHttpRequest` API. This holds the original xhr object.
+: For breadcrumbs created from HTTP requests made using the legacy `XMLHttpRequest` API. This holds the original `xhr` object.
diff --git a/src/platform-includes/configuration/breadcrumb-hints/node.mdx b/src/platform-includes/configuration/breadcrumb-hints/node.mdx
@@ -1,8 +1,7 @@
 `level` / `input`
 
-: For breadcrumbs created from console log interceptions, this holds the original console log level and the original input data to the log function.
+: For breadcrumbs created from console log interceptions. This holds the original console log level and the original input data to the log function.
 
 `request` / `response` / `event`
 
-: For breadcrumbs created from HTTP requests, this holds the request and response object
-(from the node HTTP API) as well as the node event (`response` or `error`).
+: For breadcrumbs created from HTTP requests. This holds the request and response object (from the node HTTP API) as well as the node event (`response` or `error`).
diff --git a/src/platform-includes/configuration/integrations/default-integrations/javascript.mdx b/src/platform-includes/configuration/integrations/default-integrations/javascript.mdx
@@ -1,4 +1,4 @@
-System integrations are enabled by default to integrate into the standard library or the interpreter itself. They are documented so you can be both aware of what they do and disable them if they cause issues.
+System integrations are enabled by default to integrate into the standard library or the interpreter itself. They're documented so you can understand what they do and disable them if they cause issues.
 
 ## Enabled by Default
 
@@ -11,15 +11,15 @@ message, or URLs in a given exception.
 
 It ignores errors that start with `Script error` or `Javascript error: Script error` by default.
 
-To configure this integration, use `ignoreErrors`, `denyUrls`,
+To configure this integration, use the `ignoreErrors`, `denyUrls`,
 and `allowUrls` SDK options directly. Keep in mind that `denyURLs` and `allowURLs`
-work only for captured exceptions, not raw message events.
+only work for captured exceptions, not raw message events.
 
 ### FunctionToString
 
 _Import name: `Sentry.Integrations.FunctionToString`_
 
-This integration allows the SDK to provide original functions and method names, even when our error or breadcrumbs handlers wrap them.
+This integration allows the SDK to provide original functions and method names, even when those functions or methods are wrapped by our error or breadcrumb handlers.
 
 ### TryCatch
 
@@ -81,7 +81,7 @@ Available options:
 
 _Import name: `Sentry.Integrations.LinkedErrors`_
 
-This integration allows you to configure linked errors. They’ll be recursively read up to a specified limit and lookup will be performed by a specific key. By default, the Sentry SDK sets the limit to five and the key used is `cause`.
+This integration allows you to configure linked errors. They’ll be recursively read up to a specified limit, and lookup will be performed by a specific key. By default, the Sentry SDK sets the limit to five and the key used is `cause`.
 
 Available options:
 
@@ -111,35 +111,37 @@ document
   });
 ```
 
-### HttpContext (previously: UserAgent)
+### HttpContext
+
+_(Previously: `UserAgent`)_
 
 _Import name: `Sentry.Integrations.HttpContext`_
 
 <Note>
 
 Before version 7.0.0 of the Sentry SDK, this integration was called `UserAgent`.
-It was renamed because the integration handles more than just user-agent data.
+It was renamed because the integration handles more than user-agent data.
 
 _Import name: `Sentry.Integrations.UserAgent`_
 
 </Note>
 
-This integration attaches HTTP request information, such as URL, user-agent, referrer and other headers to the event.
+This integration attaches HTTP request information, such as URL, user-agent, referrer, and other headers to the event.
 It allows us to correctly catalog and tag events with specific OS, browser, and version information.
 
 ### Dedupe
 
 _Import name: `Sentry.Integrations.Dedupe`_
 
-This integration deduplicates certain events. It can be helpful if you are receiving many duplicate errors. Note that Sentry will only compare stack traces and fingerprints. This integration is enabled by default for Browser.
+This integration deduplicates certain events. It can be helpful if you're receiving many duplicate errors. Note that Sentry only compares stack traces and fingerprints. This integration is enabled by default for Browser.
 
 <PlatformContent includePath="configuration/dedupe" />
 
 ## Modifying System Integrations
 
-To disable system integrations set `defaultIntegrations: false` when calling `init()`.
+To disable system integrations, set `defaultIntegrations: false` when calling `init()`.
 
-To override their settings, provide a new instance with your config to `integrations` option. For example, to turn off browser capturing console calls: 
+To override their settings, provide a new instance with your config to the `integrations` option. For example, to turn off browser capturing console calls: 
 
 ```javascript
 Sentry.init({
diff --git a/src/platform-includes/configuration/integrations/default-integrations/node.mdx b/src/platform-includes/configuration/integrations/default-integrations/node.mdx
@@ -1,15 +1,15 @@
-System integrations are enabled by default to integrate into the standard library or the interpreter itself. They are documented so you can be both aware of what they do and disable them if they cause issues.
+System integrations are enabled by default to integrate into the standard library or the interpreter itself. They're documented so you can understand what they do and disable them if they cause issues.
 
 ## Enabled by Default
 
 ### InboundFilters
 
 _Import name: `Sentry.Integrations.InboundFilters`_
 
-This integration allows developers to ignore specific errors based on the error message or the URL from which the exception originated.
+This integration allows you to ignore specific errors based on the error message or the URL from which the exception originated.
 
 To configure it, use the `ignoreErrors`, `denyUrls`, and `allowUrls` SDK options directly.
-(Keep in mind that `denyUrls` and `allowUrls` only work for captured exceptions, not raw message events.)
+Keep in mind that `denyUrls` and `allowUrls` only work for captured exceptions, not raw message events.
 
 ### FunctionToString
 
@@ -24,13 +24,13 @@ are wrapped by our error or breadcrumb handlers.
 
 _Import name: `Sentry.Integrations.Console`_
 
-This integration wraps the `console` module in order to record all of its calls as breadcrumbs.
+This integration wraps the `console` module to record all of its calls as breadcrumbs.
 
 ### Http
 
 _Import name: `Sentry.Integrations.Http`_
 
-This integration wraps `http` and `https` modules to capture all network requests as breadcrumbs and/or tracing spans.
+This integration wraps the `http` and `https` modules to capture all network requests as breadcrumbs and/or tracing spans.
 
 Available options:
 
@@ -48,7 +48,7 @@ _Import name: `Sentry.Integrations.OnUncaughtException`_
 This integration attaches a global uncaught exception handler. It can be modified to provide a custom shutdown function.
 The `onFatalError` option is meant to perform a cleanup before the process exits, not fully prevent it from exiting.
 
-<Alert level="warning" title="Note">
+<Alert level="warning">
 
 Be aware that if you overwrite this setting, you will lose the default implementation, which handles draining queued events before exiting. If you want to examine how it works in order to be able to recreate it in your code, see the implementation of the [`logAndExitProcess`](https://github.com/getsentry/sentry-javascript/blob/master/packages/node/src/integrations/utils/errorhandling.ts) function.
 
@@ -66,7 +66,7 @@ Available options:
 
 _Import name: `Sentry.Integrations.OnUnhandledRejection`_
 
-This integration attaches a global unhandled rejection handler. By default, all unhandled rejections trigger a warning and log the error. You can change this behavior using the `mode` option, which is in line with Node's CLI options: https://nodejs.org/api/cli.html#cli_unhandled_rejections_mode.
+This integration attaches a global unhandled rejection handler. By default, all unhandled rejections trigger a warning and log the error. You can change this behavior using the `mode` option, which is works with Node's CLI options: https://nodejs.org/api/cli.html#cli_unhandled_rejections_mode.
 
 Available options:
 
@@ -82,7 +82,7 @@ _Import name: `Sentry.Integrations.ContextLines`_
 
 _(Available in version 6.18.0 and above)_
 
-This integration adds source file context to stack frames for captured exceptions
+This integration adds source file context to stack frames for captured exceptions.
 
 Available options:
 
@@ -97,7 +97,7 @@ Available options:
 
 _Import name: `Sentry.Integrations.LinkedErrors`_
 
-This integration allows you to configure linked errors. They'll be recursively read up to a specified limit and lookup will be performed by a specific key. By default, the limit is set to 5 and the key used is `"cause"`.
+This integration allows you to configure linked errors. They'll be recursively read up to a specified limit, and lookup will be performed by a specific key. By default, the limit is set to 5 and the key used is `"cause"`.
 
 Available options:
 
@@ -118,7 +118,7 @@ This integration fetches names of all currently installed Node modules and attac
 
 ## Modifying System Integrations
 
-To disable system integrations set `defaultIntegrations: false` when calling `init()`.
+To disable system integrations, set `defaultIntegrations: false` when calling `init()`.
 
 To override an integration's settings, provide a new instance to the `integrations` option when calling `init()`. For example, to change the fatal error handler:
 
diff --git a/src/platform-includes/configuration/integrations/pluggable-integrations/javascript.mdx b/src/platform-includes/configuration/integrations/pluggable-integrations/javascript.mdx
@@ -1,8 +1,8 @@
-These pluggable integrations are snippets of code that augment functionality for specific applications and/or frameworks. We document them so you can see what they do and that they can be enabled.
+These pluggable integrations are snippets of code that augment functionality for specific applications and/or frameworks. We document them so you can understand what they do and enable them, if needed.
 
 ## How to Enable
 
-Install the `@sentry/integrations` package and provide a new instance with your config to `integrations` option. Include the plugin after the SDK has been loaded.
+Install the `@sentry/integrations` package and provide a new instance with your config to the `integrations` option. Include the plugin after the SDK has been loaded.
 
 For example:
 
@@ -12,7 +12,7 @@ For example:
 
 _Import name: `Sentry.Integrations.ExtraErrorData`_
 
-This integration extracts all non-native attributes from the Error object and attaches them to the event as the `extra` data. If the error object has a `.toJSON()` method, the `ExtraErrorData` integration will run it to extract additional information.
+This integration extracts all non-native attributes from the error object and attaches them to the event as the `extra` data. If the error object has a `.toJSON()` method, the `ExtraErrorData` integration will run it to extract additional information.
 
 Available options:
 
@@ -22,15 +22,15 @@ Available options:
 
 _Import name: `Sentry.Integrations.CaptureConsole`_
 
-This integration captures all `Console API` calls and redirects them to Sentry using the SDK's `captureMessage` or `captureException` call depending on the log level. It then retriggers to preserve default native behavior.
+This integration captures all `Console API` calls and redirects them to Sentry using the SDK's `captureMessage` or `captureException` call, depending on the log level. It then re-triggers to preserve default native behavior:
 
 <PlatformContent includePath="configuration/capture-console" />
 
 ### Debug
 
 _Import name: `Sentry.Integrations.Debug`_
 
-This integration allows you to inspect the content of the processed event, that will be passed to `beforeSend` and effectively send to the Sentry SDK. It will *always* run as the last integration, no matter when it was registered.
+This integration allows you to inspect the content of the processed event that will be passed to `beforeSend`, and effectively send it to the Sentry SDK. It will *always* run as the last integration, no matter when it was registered.
 
 Available options:
 
@@ -42,9 +42,9 @@ Available options:
 
 _Import name: `Sentry.Integrations.Offline`_
 
-This integration uses the web browser's [online and offline events](https://developer.mozilla.org/en-US/docs/Web/API/NavigatorOnLine/Online_and_offline_events) to detect when no network connectivity is available. If offline, it saves events to the web browser's client-side storage (typically IndexedDB) then automatically uploads events when network connectivity is restored.
+This integration uses the web browser's [online and offline events](https://developer.mozilla.org/en-US/docs/Web/API/NavigatorOnLine/Online_and_offline_events) to detect when no network connectivity is available. If offline, it saves events to the web browser's client-side storage (typically IndexedDB), then automatically uploads events when network connectivity is restored.
 
-This plugin does not attempt to provide local storage or retries for other scenarios. For example, if the browser has a local area connection but no internet connection, then it may report that it's online, and Sentry's `Offline` plugin will not attempt to save or retry any send failures in this case.
+This plugin does not attempt to provide local storage or retries for other scenarios. For example, if the browser has a local area connection but no internet connection, then it may report that it's online, and Sentry's `Offline` plugin will not attempt to save or retry any send failures in this case:
 
 <PlatformContent includePath="configuration/offline" />
 
@@ -56,7 +56,7 @@ _Import name: `Sentry.Integrations.RewriteFrames`_
 
 This integration allows you to apply a transformation to each frame of the stack trace. In the streamlined scenario, it can be used to change the name of the file frame it originates from, or it can be fed with an iterated function to apply any arbitrary transformation.
 
-On Windows machines, you have to use Unix paths and skip the volume letter in `root` option to enable. For example `C:\\Program Files\\Apache\\www` won’t work, however, `/Program Files/Apache/www` will.
+On Windows machines, you have to use Unix paths and skip the volume letter in the `root` option to enable it. For example, `C:\\Program Files\\Apache\\www` won’t work, however, `/Program Files/Apache/www` will.
 
 Available options:
 
diff --git a/src/platform-includes/configuration/integrations/pluggable-integrations/node.mdx b/src/platform-includes/configuration/integrations/pluggable-integrations/node.mdx
@@ -1,4 +1,4 @@
-Pluggable integrations are integrations that can be additionally enabled, to provide specific features. They're documented so you can see what they do and that they can be enabled. To enable pluggable integrations, provide a new instance with your config to the `integrations` option. For example: `integrations: [new Sentry.Integrations.Modules()]`.
+Pluggable integrations are integrations that can be additionally enabled to provide specific features. They're documented so you can understand what they do and enable them, if needed. To enable pluggable integrations, provide a new instance with your config to the `integrations` option. For example: `integrations: [new Sentry.Integrations.Modules()]`.
 
 ## Core
 
@@ -7,7 +7,7 @@ Pluggable integrations are integrations that can be additionally enabled, to pro
 _Import name: `Sentry.Integrations.CaptureConsole`_
 
 This integration captures all `Console API` calls and redirects them to Sentry using `captureMessage` call.
-It then retriggers to preserve default native behavior.
+It then re-triggers to preserve default native behavior.
 
 Available options:
 
@@ -21,7 +21,7 @@ Available options:
 
 _Import name: `Sentry.Integrations.Dedupe`_
 
-This integration deduplicates certain events. It can be helpful if you are receiving many duplicate errors. Be aware that we will only compare stack traces and fingerprints.
+This integration deduplicates certain events. It can be helpful if you're receiving many duplicate errors. Be aware that we will only compare stack traces and fingerprints.
 
 ### Debug
 
@@ -43,7 +43,7 @@ Available options:
 
 _Import name: `Sentry.Integrations.ExtraErrorData`_
 
-This integration extracts all non-native attributes from the Error object and attaches them to the event as the `extra` data.
+This integration extracts all non-native attributes from the error object and attaches them to the event as the `extra` data.
 
 Available options:
 
@@ -62,12 +62,12 @@ _Import name: `Sentry.Integrations.RewriteFrames`_
 
 This integration allows you to apply a transformation to each frame of the stack trace. In the streamlined scenario, it can be used to change the name of the file frame it originates from, or it can be fed with an iterated function to apply any arbitrary transformation.
 
-On Windows machines, you have to use Unix paths and skip the volume letter in `root` option in order to make it work.
-For example `C:\\Program Files\\Apache\\www` won't work, however, `/Program Files/Apache/www` will.
+On Windows machines, you have to use Unix paths and skip the volume letter in the `root` option to make it work.
+For example, `C:\\Program Files\\Apache\\www` won't work, however, `/Program Files/Apache/www` will.
 
 <PlatformContent includePath="configuration/rewrite-frames" />
 
-## Node specific
+## Node-specific
 
 ### Transaction
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		-You can pass an `Error` object to `captureException()` to get it captured as event. It's also possible to pass non-Error objects and strings, but be aware that the resulting events in Sentry may be missing a stacktrace.
	`1`	+You can pass an `Error` object to `captureException()` to have it captured as event. It's also possible to pass non-`Error` objects and strings, but be aware that the resulting events in Sentry may be missing a stack trace.
`2`	`2`
`3`	`3`	```javascript
`4`	`4`	`import * as Sentry from '@sentry/node';`