Skip to content

style(prettier): Consistent italics and bold styling #6705

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,10 @@ When modifying data in the file, Sentry cannot modify the length of the file. Th

Here is how this works specifically for each method:

- *Remove*: As the entire field is removed, it is essentially replaced with the padding character.
- *Mask*: This behaves as normal, all data is replaced with `*` masking character.
- *Hash*: Hashing happens as usual, however the **binary representation** of the match is hashed, regardless of the encoding in which the match was made. The resulting hash is padded or truncated as described above.
- *Replace*: This behaves like normal, with the replacement being padded or truncated as described above.

- _Remove_: As the entire field is removed, it is essentially replaced with the padding character.
- _Mask_: This behaves as normal, all data is replaced with `*` masking character.
- _Hash_: Hashing happens as usual, however the **binary representation** of the match is hashed, regardless of the encoding in which the match was made. The resulting hash is padded or truncated as described above.
- _Replace_: This behaves like normal, with the replacement being padded or truncated as described above.

## Attachment Source Selectors

Expand Down Expand Up @@ -66,11 +65,11 @@ For the purpose of PII scrubbing, we currently represent the minidump as a flat

Similar to stack memory, all [data types](../advanced-datascrubbing/#data-types) are matched as a binary UTF-8 regular expression as well as in any valid UTF-16LE strings found within the binary memory region.

- A minidump also contains a list of **code modules**, which are loaded at the time the minidump is created.
- A minidump also contains a list of **code modules**, which are loaded at the time the minidump is created.
This module list contains information about each module, including two fields that may contain file paths: the path of the code file and the path of the associated debug file.

Since these fields are pathnames, they have the potential to contain a user's home directory.
As a result, it makes sense to apply the *Usernames in filepaths* [data type](../advanced-datascrubbing/#data-types) to these fields.
As a result, it makes sense to apply the _Usernames in filepaths_ [data type](../advanced-datascrubbing/#data-types) to these fields.
The fields can be selected individually by their respective field names:

* `code_file`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Use Microsoft Teams for [alerts](/product/alerts/) regarding issues, environment

### Alert Rules

Set up an alert rule by going to **Alerts** and clicking "Create Alert*". From here, you can configure alerts to route notifications to your Microsoft Team's channels.
Set up an alert rule by going to **Alerts** and clicking "Create Alert\*". From here, you can configure alerts to route notifications to your Microsoft Team's channels.

In [issue alerts](/product/alerts/alert-types/#issue-alerts), select "Send a Microsoft Teams notification" in the actions dropdown and then select your team and channel:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ You can receive [team alert notifications](/product/alerts/create-alerts/issue-a

### Alert Rules

Set up an alert rule by going to **Alerts** and clicking "Create Alert*". From here, you can configure alerts to route notifications to your Slack workspace(s).
Set up an alert rule by going to **Alerts** and clicking "Create Alert\*". From here, you can configure alerts to route notifications to your Slack workspace(s).

In [issue alerts](/product/alerts/alert-types/#issue-alerts), select "Send a Slack notification" in the actions dropdown and then select your workspace and channel:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ The detector for this performance issue looks at the total non-overlapping durat
Span evidence identifies the root cause of the Database on Main Thread problem by showing you three main aspects:

- **Transaction name**
- **Parent Span:** Where the database spans occurred
- **Parent Span:** Where the database spans occurred
- **Offending Span:** The actual spans that are performing database queries in the main thread

![Database Span Evidence](db-io.png)

View it by going to the **Issues** page in Sentry, selecting your Android project, clicking on the database error you want to examine, then scrolling down to the "Span Evidence" section in the "Details" tab.
View it by going to the **Issues** page in Sentry, selecting your Android project, clicking on the database error you want to examine, then scrolling down to the "Span Evidence" section in the "Details" tab.
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ View it by going to the **Issues** page in Sentry, clicking on the issue you wan

![Image Decoding on Main Thread Function Evidence](image-decoding-function-evidence.png)

The profile will indicate where the suspect function was called from, along with other functions being called *by* the suspect function:
The profile will indicate where the suspect function was called from, along with other functions being called _by_ the suspect function:

![Image Decoding on Main Thread Profile](image-decoding-profile.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ View it by going to the **Issues** page in Sentry, clicking on the issue you wan

![JSON Decoding on Main Thread Function Evidence](json-decoding-function-evidence.png)

The profile will indicate where the suspect function was called from, along with other functions being called *by* the suspect function:
The profile will indicate where the suspect function was called from, along with other functions being called _by_ the suspect function:

![JSON Decoding on Main Thread Profile](json-decoding-profile.png)

Expand Down
2 changes: 1 addition & 1 deletion src/docs/product/profiling/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Profiling is designed to address all of these issues:
- **The environments are diverse and reflect real world conditions.** We collect performance data automatically from every environment that your app is running on in the real world, accounting for different device hardware, OS versions, app versions, network conditions, and more.
- **We cover the widest possible set of user flows.** Since the data is collected from actual users using your app as they normally would, we can capture all kinds of usage patterns that you may not have thought about when building your own performance tests.
- **Metrics are calculated using a large number of samples.** We can collect data from up to 100% of your user population in production, allowing us to compute more accurate metrics.
- **The process is simple.** Integrate the Sentry SDK, enable profiling, ship your app, and let us worry about analyzing performance and detecting regressions between versions. We encourage *testing in production*, which improves developer velocity and reduces the overhead of having to maintain your own tests and tooling. Our dashboard is designed to be approachable to all engineers, and not just people who have a performance engineering background.
- **The process is simple.** Integrate the Sentry SDK, enable profiling, ship your app, and let us worry about analyzing performance and detecting regressions between versions. We encourage _testing in production_, which improves developer velocity and reduces the overhead of having to maintain your own tests and tooling. Our dashboard is designed to be approachable to all engineers, and not just people who have a performance engineering background.
- **The overhead is minimal.** Depending on the platform, the overhead can be lower than 1% of your app’s CPU time.

## Learn More
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ In this tutorial, you create a new _project_ in your Sentry account. Projects al

## Step 2: Create an alert rule

You can create various [alert rules](/product/alerts-notifications/alerts/) for each project and let Sentry know when, how, and whom you want to notify when errors occur in your application. *Alert rules* consist of *conditions* and *actions*, which are performed when the associated conditions are met. When creating a new project, you can choose to create it with an alert rule that notifies all project team members (by email) the first time a new *issue* appears. This means that the next time a **similar error** occurs, the notification is not triggered since the error is not "new".
You can create various [alert rules](/product/alerts-notifications/alerts/) for each project and let Sentry know when, how, and whom you want to notify when errors occur in your application. _Alert rules_ consist of _conditions_ and _actions_, which are performed when the associated conditions are met. When creating a new project, you can choose to create it with an alert rule that notifies all project team members (by email) the first time a new _issue_ appears. This means that the next time a **similar error** occurs, the notification is not triggered since the error is not "new".

In this step, you create a new alert rule that notifies **every time** an event occurs, even if it's associated with an already existing issue. In a real-life scenario you'd probably add additional conditions, as you wouldn't want to be notified every time an event happens in your frontend code on your end user's browsers.

Expand Down
2 changes: 1 addition & 1 deletion src/platform-includes/capture-error/apple.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ By default, macOS applications do not crash whenever an uncaught exception occur

This feature is available on [sentry-cocoa 7.25.0](https://github.com/getsentry/sentry-cocoa/blob/master/CHANGELOG.md#7250) and above.

Sentry will display the error code in the error description field by default. For custom error types, you may want to provide a custom description to make it easier to identify the error in the *Issues* page. For `NSError` values, this can be done by adding a description to the `userInfo` dictionary with the key `NSDebugDescriptionErrorKey`.
Sentry will display the error code in the error description field by default. For custom error types, you may want to provide a custom description to make it easier to identify the error in the _Issues_ page. For `NSError` values, this can be done by adding a description to the `userInfo` dictionary with the key `NSDebugDescriptionErrorKey`.

Sentry will group errors based on the error domain and code, and by enum value for Swift enum types, so customizing error descriptions won’t impact grouping.

Expand Down
2 changes: 1 addition & 1 deletion src/platform-includes/debug-symbols-apple/_default.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

Sentry requires dSYMs (debug information files) to symbolicate your stacktraces. The symbolication process unscrambles the stacktraces to reveal the function, file names, and line numbers of the crash.

Every solution requires a __Sentry Auth Token__. We recommend [using internal integrations](https://sentry.io/settings/developer-settings/) for managing Auth Tokens. [Create a new internal integration](https://sentry.io/settings/developer-settings/new-internal/) with the permission `project:read&write`, if you don't have one already. After saving it, you can copy the Auth Token from the integration page.
Every solution requires a **Sentry Auth Token**. We recommend [using internal integrations](https://sentry.io/settings/developer-settings/) for managing Auth Tokens. [Create a new internal integration](https://sentry.io/settings/developer-settings/new-internal/) with the permission `project:read&write`, if you don't have one already. After saving it, you can copy the Auth Token from the integration page.

![Integration Auth Token](integration-tokens.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ Supported on Android OS version `7.0` and above.

</Note>

Unresponsive UI and animation hitches annoy users and degrade the user experience. Two measurements to track these types of experiences are *slow frames* and *frozen frames*. If you want your app to run smoothly, you should try to avoid both. The SDK adds these two measurements for the [Android's Activity](/platforms/android/performance/instrumentation/automatic-instrumentation/#androids-activity-instrumentation) transactions.
Unresponsive UI and animation hitches annoy users and degrade the user experience. Two measurements to track these types of experiences are _slow frames_ and _frozen frames_. If you want your app to run smoothly, you should try to avoid both. The SDK adds these two measurements for the [Android's Activity](/platforms/android/performance/instrumentation/automatic-instrumentation/#androids-activity-instrumentation) transactions.

Slow and frozen frames are Mobile Vitals, which you can learn about in the [full documentation](/product/performance/mobile-vitals).

Expand Down
2 changes: 1 addition & 1 deletion src/platforms/android/configuration/bill-of-materials.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: 'Learn more about using a bill of materials with multiple Sentry de
sidebar_order: 1000
---

When you are using multiple Sentry dependencies, you can avoid specifying the version of each dependency with a *BOM* or *Bill Of Materials*.
When you are using multiple Sentry dependencies, you can avoid specifying the version of each dependency with a _BOM_ or _Bill Of Materials_.

Using Gradle 5.0 or higher, you can add the following to the `dependencies` section in your `build.gradle`:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ class LyricsActivity : ComponentActivity() {
}
```

To view the recorded transaction, log into [sentry.io](https://sentry.io) and open your project. Clicking **Performance** will open a page with transactions, where you can select the just recorded transaction with the name `Track Interaction`. The event will look similar to this:
To view the recorded transaction, log into [sentry.io](https://sentry.io) and open your project. Clicking **Performance** will open a page with transactions, where you can select the just recorded transaction with the name `Track Interaction`. The event will look similar to this:

![File I/O performance instrumentation](file-io-instrumentation.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -337,4 +337,4 @@ try {
}
```

We recommend you identify those errors and __not__ capture them manually with the `Sentry.captureException` method.
We recommend you identify those errors and **not** capture them manually with the `Sentry.captureException` method.
24 changes: 18 additions & 6 deletions src/platforms/apple/common/configuration/swizzling.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,26 @@ description: 'Learn which features use swizzling'

The Cocoa SDK uses [swizzling](https://nshipster.com/method-swizzling/) to provide some features out of the box without boilerplate code. The following features use swizzling:

__macOS__
- <PlatformLink to="/enriching-events/breadcrumbs/">Breadcrumbs for touch events</PlatformLink>
- <PlatformLink to="/performance/instrumentation/automatic-instrumentation/#network-tracking">Auto instrumentation for HTTP requests</PlatformLink>
- <PlatformLink to="/performance/instrumentation/automatic-instrumentation/#file-io-tracing">Auto instrumentation for File I/O operations</PlatformLink>
- <PlatformLink to="/performance/instrumentation/automatic-instrumentation/#core-data-tracing">Auto instrumentation for Core Data operations</PlatformLink>
- <PlatformLink to="/performance/connect-services/">Automatically added sentry-trace header to HTTP requests for distributed tracing</PlatformLink>
**macOS**

- <PlatformLink to="/enriching-events/breadcrumbs/">
Breadcrumbs for touch events
</PlatformLink>
- <PlatformLink to="/performance/instrumentation/automatic-instrumentation/#network-tracking">
Auto instrumentation for HTTP requests
</PlatformLink>
- <PlatformLink to="/performance/instrumentation/automatic-instrumentation/#file-io-tracing">
Auto instrumentation for File I/O operations
</PlatformLink>
- <PlatformLink to="/performance/instrumentation/automatic-instrumentation/#core-data-tracing">
Auto instrumentation for Core Data operations
</PlatformLink>
- <PlatformLink to="/performance/connect-services/">
Automatically added sentry-trace header to HTTP requests for distributed tracing
</PlatformLink>
- <PlatformLink to="/configuration/http-client-errors/">HTTP Client Errors</PlatformLink>

**iOS, tvOS and Catalyst**

__iOS, tvOS and Catalyst__

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,6 @@ Alternatively, when your project uses a `Package.swift` file to manage dependenc

<Note>

Version tags or branches need to have the Package.swift file in it or Xcode won't be able to install the package. This means versions previous to `4.4.3` *cannot* be installed using SPM.
Version tags or branches need to have the Package.swift file in it or Xcode won't be able to install the package. This means versions previous to `4.4.3` _cannot_ be installed using SPM.

</Note>
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ SentrySDK.start { options in

This feature is available for iOS, tvOS, and Mac Catalyst.

Slow and Frozen Frames are enabled by default once you <PlatformLink to="/performance/">set up performance monitoring</PlatformLink>. Unresponsive UI and animation hitches annoy users and degrade the user experience. Two measurements to track these types of experiences are *slow frames* and *frozen frames*. If you want your app to run smoothly, you should try to avoid both. The SDK adds these two measurements for the transactions you capture.
Slow and Frozen Frames are enabled by default once you <PlatformLink to="/performance/">set up performance monitoring</PlatformLink>. Unresponsive UI and animation hitches annoy users and degrade the user experience. Two measurements to track these types of experiences are _slow frames_ and _frozen frames_. If you want your app to run smoothly, you should try to avoid both. The SDK adds these two measurements for the transactions you capture.

The detail view of the transaction displays the slow, frozen, and total frames:

Expand Down
2 changes: 1 addition & 1 deletion src/platforms/dart/configuration/integrations/file.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -81,4 +81,4 @@ Future<void> runApp() async {
}
```

To view the recorded transaction, log into [sentry.io](https://sentry.io) and open your project. Clicking **Performance** will open a page with transactions, where you can select the just recorded transaction with the name `MyFileExample`.
To view the recorded transaction, log into [sentry.io](https://sentry.io) and open your project. Clicking **Performance** will open a page with transactions, where you can select the just recorded transaction with the name `MyFileExample`.
2 changes: 1 addition & 1 deletion src/platforms/dotnet/common/configuration/msbuild.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ This enables the display of [source context](../../data-management/debug-files/s
<Note>

If you are already embedding source code in your symbol files using [`EmbedAllSources`](https://github.com/dotnet/sourcelink/blob/main/docs/README.md#embedallsources),
you do not need to upload them to Sentry separately. In other words, use *either* `SentryUploadSources` or `EmbedAllSources`, not both.
you do not need to upload them to Sentry separately. In other words, use _either_ `SentryUploadSources` or `EmbedAllSources`, not both.

</Note>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Using a BOM
sidebar_order: 1000
---

When you are using multiple Sentry dependencies, you can avoid specifying the version of each dependency with a *BOM* or *Bill Of Materials*.
When you are using multiple Sentry dependencies, you can avoid specifying the version of each dependency with a _BOM_ or _Bill Of Materials_.

Using Maven, add the following to the `dependencyManagement` section in your `pom.xml`:

Expand Down
2 changes: 1 addition & 1 deletion src/platforms/node/guides/aws-lambda/layer/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Then add the Sentry Layer by navigating to your Lambda function. Select **Layers

![](lambda_view.png)

**Specify an ARN** tab as illustrated:
**Specify an ARN** tab as illustrated:

![](add_layer.png)

Expand Down
2 changes: 1 addition & 1 deletion src/platforms/python/guides/aws-lambda/layer/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Then **Add a Layer**.

![](layer_view.png)

**Specify an ARN** tab as illustrated:
**Specify an ARN** tab as illustrated:

![](add_layer.png)

Expand Down
2 changes: 1 addition & 1 deletion src/platforms/unity/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ public class PreBuildProcessor : IPreprocessBuildWithReport
}
```

### Build input file cannot be found: '**/Libraries/io.sentry.unity/Plugins/iOS/SentryNativeBridge.m'
### Build input file cannot be found: '\*\*/Libraries/io.sentry.unity/Plugins/iOS/SentryNativeBridge.m'

You can resolve this issue by creating a clean build or chosing "Replace" when prompted. Alternatively, you can remove the unused `SentryNativeBridge.m`from the **UnityFramework Target > Compile Sources** in the project settings. Instead of relying on Unity to copy the `SentryNativeBridge.m` over to the generated Xcode project, starting with 0.12.0, the SDK copies it manually to `**/Libraries/io.sentry.unity/SentryNativeBridge.m`.

Expand Down
Loading