diff --git a/Sources/Testing/Issues/Issue.swift b/Sources/Testing/Issues/Issue.swift index 9d2e9fc90..beeca101e 100644 --- a/Sources/Testing/Issues/Issue.swift +++ b/Sources/Testing/Issues/Issue.swift @@ -13,7 +13,7 @@ public struct Issue: Sendable { /// Kinds of issues which may be recorded. public enum Kind: Sendable { /// An issue which occurred unconditionally, for example by using - /// ``Issue/record(_:sourceLocation:)``. + /// ``Issue/record(_:severity:sourceLocation:)``. case unconditional /// An issue due to a failed expectation, such as those produced by @@ -409,7 +409,7 @@ extension Issue.Kind { @_spi(ForToolsIntegrationOnly) public enum Snapshot: Sendable, Codable { /// An issue which occurred unconditionally, for example by using - /// ``Issue/record(_:sourceLocation:)``. + /// ``Issue/record(_:severity:sourceLocation:)``. case unconditional /// An issue due to a failed expectation, such as those produced by diff --git a/Sources/Testing/Support/CustomIssueRepresentable.swift b/Sources/Testing/Support/CustomIssueRepresentable.swift index d76739d1f..77f7b23b0 100644 --- a/Sources/Testing/Support/CustomIssueRepresentable.swift +++ b/Sources/Testing/Support/CustomIssueRepresentable.swift @@ -12,7 +12,7 @@ /// record themselves as test issues. /// /// When a type conforms to this protocol, values of that type can be passed to -/// ``Issue/record(_:_:)``. The testing library then calls the +/// ``Issue/record(_:severity:sourceLocation:)``. The testing library then calls the /// ``customize(_:)`` function and passes it an instance of ``Issue`` that will /// be used to represent the value. The function can then reconfigure or replace /// the issue as needed. @@ -43,7 +43,7 @@ protocol CustomIssueRepresentable: Error { /// /// This type is not part of the public interface of the testing library. /// External callers should generally record issues by throwing their own errors -/// or by calling ``Issue/record(_:sourceLocation:)``. +/// or by calling ``Issue/record(_:severity:sourceLocation:)``. struct SystemError: Error, CustomStringConvertible, CustomIssueRepresentable { var description: String @@ -62,7 +62,7 @@ struct SystemError: Error, CustomStringConvertible, CustomIssueRepresentable { /// /// This type is not part of the public interface of the testing library. /// External callers should generally record issues by throwing their own errors -/// or by calling ``Issue/record(_:sourceLocation:)``. +/// or by calling ``Issue/record(_:severity:sourceLocation:)``. struct APIMisuseError: Error, CustomStringConvertible, CustomIssueRepresentable { var description: String diff --git a/Sources/Testing/Testing.docc/MigratingFromXCTest.md b/Sources/Testing/Testing.docc/MigratingFromXCTest.md index 60744ba7a..81434b8c3 100644 --- a/Sources/Testing/Testing.docc/MigratingFromXCTest.md +++ b/Sources/Testing/Testing.docc/MigratingFromXCTest.md @@ -277,7 +277,7 @@ XCTest has a function, [`XCTFail()`](https://developer.apple.com/documentation/x that causes a test to fail immediately and unconditionally. This function is useful when the syntax of the language prevents the use of an `XCTAssert()` function. To record an unconditional issue using the testing library, use the -``Issue/record(_:sourceLocation:)`` function: +``Issue/record(_:severity:sourceLocation:)`` function: @Row { @Column {