Skip to content

Update docc comments for Issue.record #1257

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.

Sign up for GitHub

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
merged 2 commits into from
Aug 8, 2025
Merged

Update docc comments for Issue.record #1257

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ddecd15
Update docc comments for Issue.record
suzannaratcliff Aug 8, 2025
9a4030e
Update Sources/Testing/Support/CustomIssueRepresentable.swift
suzannaratcliff Aug 8, 2025
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
4 changes: 2 additions & 2 deletions Sources/Testing/Issues/Issue.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions Sources/Testing/Support/CustomIssueRepresentable.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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

Expand All @@ -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

Expand Down
2 changes: 1 addition & 1 deletion Sources/Testing/Testing.docc/MigratingFromXCTest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down