Skip to content

Commit e7004a1

Browse files
Fix formatting
1 parent 3adec7d commit e7004a1

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

proposals/testing/XXXX-issue-severity-warning.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
* Review Manager: TBD
66
* Status: **Pitched**
77
* Implementation: [swiftlang/swift-testing#1075](https://github.com/swiftlang/swift-testing/pull/1075)
8-
* Review: ([pitch](https://forums.swift.org/t/pitch-test-issue-warnings/79285)
8+
* Review: ([pitch](https://forums.swift.org/t/pitch-test-issue-warnings/79285))
99

1010
## Introduction
1111

@@ -38,7 +38,7 @@ Test authors will be able to inspect if the issue is a failing issue and will be
3838

3939
## Detailed design
4040

41-
###Severity Enum
41+
### Severity Enum
4242

4343
We introduce a Severity enum to categorize issues detected during testing. This enum is crucial for distinguishing between different levels of test issues and is defined as follows:
4444

@@ -65,7 +65,7 @@ extension Issue {
6565
}
6666
```
6767

68-
###Recording Non-Failing Issues
68+
### Recording Non-Failing Issues
6969
To enable test authors to log non-failing issues without affecting test results, we provide a method for recording such issues:
7070

7171
```swift
@@ -96,7 +96,7 @@ Here is the `Issue.record` method definition with severity as a parameter.
9696
// ...
9797
```
9898

99-
###Issue Type Enhancements
99+
### Issue Type Enhancements
100100

101101
The Issue type is enhanced with two new properties to better handle and report issues:
102102
- `severity`: This property allows access to the specific severity level of an issue, enabling more precise handling of test results.
@@ -131,7 +131,7 @@ extension Issue {
131131
}
132132
```
133133

134-
Example usage of `severity` and `isFailure:
134+
Example usage of `severity` and `isFailure`:
135135
```swift
136136
// ...
137137
withKnownIssue {
@@ -185,7 +185,7 @@ When there is an issue recorded with severity warning the output looks like this
185185
To use severity today, checkout the branch here: https://github.com/swiftlang/swift-testing/pull/1189
186186

187187
```
188-
.package(url: "https://github.com/swiftlang/swift-testing.git", branch: "suzannaratcliff:suzannaratcliff/enable-severity"),
188+
.package(url: "https://github.com/suzannaratcliff/swift-testing.git", branch: "suzannaratcliff:suzannaratcliff/enable-severity"),
189189
```
190190

191191
For more details on how to checkout a branch for a package refer to this: https://developer.apple.com/documentation/packagedescription/package/dependency/package(url:branch:)

0 commit comments

Comments
 (0)