Skip to content

Commit b01faac

Browse files
style(prettier): Consistent italics and bold styling (#6703)
1 parent 5604d19 commit b01faac

File tree

24 files changed

+47
-36
lines changed

24 files changed

+47
-36
lines changed

src/docs/product/data-management-settings/scrubbing/attachment-scrubbing.mdx

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,10 @@ When modifying data in the file, Sentry cannot modify the length of the file. Th
2222

2323
Here is how this works specifically for each method:
2424

25-
- *Remove*: As the entire field is removed, it is essentially replaced with the padding character.
26-
- *Mask*: This behaves as normal, all data is replaced with `*` masking character.
27-
- *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.
28-
- *Replace*: This behaves like normal, with the replacement being padded or truncated as described above.
29-
25+
- _Remove_: As the entire field is removed, it is essentially replaced with the padding character.
26+
- _Mask_: This behaves as normal, all data is replaced with `*` masking character.
27+
- _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.
28+
- _Replace_: This behaves like normal, with the replacement being padded or truncated as described above.
3029

3130
## Attachment Source Selectors
3231

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

6766
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.
6867

69-
- A minidump also contains a list of **code modules**, which are loaded at the time the minidump is created.
68+
- A minidump also contains a list of **code modules**, which are loaded at the time the minidump is created.
7069
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.
7170

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

7675
* `code_file`

src/docs/product/integrations/notification-incidents/msteams/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Use Microsoft Teams for [alerts](/product/alerts/) regarding issues, environment
4040

4141
### Alert Rules
4242

43-
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.
43+
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.
4444

4545
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:
4646

src/docs/product/integrations/notification-incidents/slack/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ You can receive [team alert notifications](/product/alerts/create-alerts/issue-a
5858

5959
### Alert Rules
6060

61-
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).
61+
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).
6262

6363
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:
6464

src/docs/product/issues/issue-details/performance-issues/db-main-thread-io.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ The detector for this performance issue looks at the total non-overlapping durat
2424
Span evidence identifies the root cause of the Database on Main Thread problem by showing you three main aspects:
2525

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

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

32-
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.
32+
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.

src/docs/product/issues/issue-details/performance-issues/image-decoding-main-thread/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ View it by going to the **Issues** page in Sentry, clicking on the issue you wan
2727

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

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

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

src/docs/product/issues/issue-details/performance-issues/json-decoding-main-thread/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ View it by going to the **Issues** page in Sentry, clicking on the issue you wan
2929

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

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

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

src/docs/product/profiling/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Profiling is designed to address all of these issues:
3838
- **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.
3939
- **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.
4040
- **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.
41-
- **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.
41+
- **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.
4242
- **The overhead is minimal.** Depending on the platform, the overhead can be lower than 1% of your app’s CPU time.
4343

4444
## Learn More

src/docs/product/sentry-basics/integrate-frontend/create-new-project.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ In this tutorial, you create a new _project_ in your Sentry account. Projects al
4747

4848
## Step 2: Create an alert rule
4949

50-
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".
50+
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".
5151

5252
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.
5353

src/platform-includes/capture-error/apple.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ By default, macOS applications do not crash whenever an uncaught exception occur
3131
3232
This feature is available on [sentry-cocoa 7.25.0](https://github.com/getsentry/sentry-cocoa/blob/master/CHANGELOG.md#7250) and above.
3333
34-
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`.
34+
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`.
3535
3636
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.
3737

src/platform-includes/debug-symbols-apple/_default.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
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.
33

4-
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.
4+
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.
55

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

src/platforms/android/common/performance/instrumentation/automatic-instrumentation.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ Supported on Android OS version `7.0` and above.
159159

160160
</Note>
161161

162-
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.
162+
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.
163163

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

src/platforms/android/configuration/bill-of-materials.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: 'Learn more about using a bill of materials with multiple Sentry de
44
sidebar_order: 1000
55
---
66

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

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

src/platforms/android/configuration/integrations/file-io.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ class LyricsActivity : ComponentActivity() {
123123
}
124124
```
125125

126-
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:
126+
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:
127127

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

src/platforms/android/configuration/integrations/okhttp.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -337,4 +337,4 @@ try {
337337
}
338338
```
339339

340-
We recommend you identify those errors and __not__ capture them manually with the `Sentry.captureException` method.
340+
We recommend you identify those errors and **not** capture them manually with the `Sentry.captureException` method.

src/platforms/apple/common/configuration/swizzling.mdx

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,26 @@ description: 'Learn which features use swizzling'
66

77
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:
88

9-
__macOS__
10-
- <PlatformLink to="/enriching-events/breadcrumbs/">Breadcrumbs for touch events</PlatformLink>
11-
- <PlatformLink to="/performance/instrumentation/automatic-instrumentation/#network-tracking">Auto instrumentation for HTTP requests</PlatformLink>
12-
- <PlatformLink to="/performance/instrumentation/automatic-instrumentation/#file-io-tracing">Auto instrumentation for File I/O operations</PlatformLink>
13-
- <PlatformLink to="/performance/instrumentation/automatic-instrumentation/#core-data-tracing">Auto instrumentation for Core Data operations</PlatformLink>
14-
- <PlatformLink to="/performance/connect-services/">Automatically added sentry-trace header to HTTP requests for distributed tracing</PlatformLink>
9+
**macOS**
10+
11+
- <PlatformLink to="/enriching-events/breadcrumbs/">
12+
Breadcrumbs for touch events
13+
</PlatformLink>
14+
- <PlatformLink to="/performance/instrumentation/automatic-instrumentation/#network-tracking">
15+
Auto instrumentation for HTTP requests
16+
</PlatformLink>
17+
- <PlatformLink to="/performance/instrumentation/automatic-instrumentation/#file-io-tracing">
18+
Auto instrumentation for File I/O operations
19+
</PlatformLink>
20+
- <PlatformLink to="/performance/instrumentation/automatic-instrumentation/#core-data-tracing">
21+
Auto instrumentation for Core Data operations
22+
</PlatformLink>
23+
- <PlatformLink to="/performance/connect-services/">
24+
Automatically added sentry-trace header to HTTP requests for distributed tracing
25+
</PlatformLink>
1526
- <PlatformLink to="/configuration/http-client-errors/">HTTP Client Errors</PlatformLink>
1627

28+
**iOS, tvOS and Catalyst**
1729

1830
__iOS, tvOS and Catalyst__
1931

src/platforms/apple/common/install/swift-package-manager.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,6 @@ Alternatively, when your project uses a `Package.swift` file to manage dependenc
1919

2020
<Note>
2121

22-
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.
22+
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.
2323

2424
</Note>

src/platforms/apple/common/performance/instrumentation/automatic-instrumentation.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ SentrySDK.start { options in
124124
125125
This feature is available for iOS, tvOS, and Mac Catalyst.
126126
127-
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.
127+
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.
128128
129129
The detail view of the transaction displays the slow, frozen, and total frames:
130130

src/platforms/dart/configuration/integrations/file.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,4 +81,4 @@ Future<void> runApp() async {
8181
}
8282
```
8383

84-
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`.
84+
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`.

src/platforms/dotnet/common/configuration/msbuild.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ This enables the display of [source context](../../data-management/debug-files/s
170170
<Note>
171171

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

175175
</Note>
176176

src/platforms/java/common/configuration/bill-of-materials.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Using a BOM
33
sidebar_order: 1000
44
---
55

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

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

src/platforms/node/guides/aws-lambda/layer/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Then add the Sentry Layer by navigating to your Lambda function. Select **Layers
1919

2020
![](lambda_view.png)
2121

22-
**Specify an ARN** tab as illustrated:
22+
**Specify an ARN** tab as illustrated:
2323

2424
![](add_layer.png)
2525

src/platforms/python/guides/aws-lambda/layer/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Then **Add a Layer**.
1717

1818
![](layer_view.png)
1919

20-
**Specify an ARN** tab as illustrated:
20+
**Specify an ARN** tab as illustrated:
2121

2222
![](add_layer.png)
2323

src/platforms/unity/troubleshooting.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ public class PreBuildProcessor : IPreprocessBuildWithReport
8080
}
8181
```
8282

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

8585
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`.
8686

0 commit comments

Comments
 (0)