Skip to content

Update documentation for new confirmation() overload. #784

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
merged 2 commits into from
Oct 28, 2024
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
8 changes: 4 additions & 4 deletions Sources/Testing/Issues/Confirmation.swift
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ public func confirmation<R>(
/// preconditions have been met, and records an issue if they have not.
///
/// If an exact count is expected, use
/// ``confirmation(_:expectedCount:isolation:sourceLocation:_:)`` instead.
/// ``confirmation(_:expectedCount:isolation:sourceLocation:_:)-5mqz2`` instead.
public func confirmation<R>(
_ comment: Comment? = nil,
expectedCount: some RangeExpression<Int> & Sequence<Int> & Sendable,
Expand All @@ -183,7 +183,7 @@ public func confirmation<R>(
return try await body(confirmation)
}

/// An overload of ``confirmation(_:expectedCount:isolation:sourceLocation:_:)-6bkl6``
/// An overload of ``confirmation(_:expectedCount:isolation:sourceLocation:_:)-l3il``
/// that handles the unbounded range operator (`...`).
///
/// This overload is necessary because `UnboundedRange` does not conform to
Expand All @@ -200,7 +200,7 @@ public func confirmation<R>(
fatalError("Unsupported")
}

/// An overload of ``confirmation(_:expectedCount:isolation:sourceLocation:_:)-6bkl6``
/// An overload of ``confirmation(_:expectedCount:isolation:sourceLocation:_:)-l3il``
/// that handles the partial-range-through operator (`...n`).
///
/// This overload is necessary because the lower bound of `PartialRangeThrough`
Expand All @@ -216,7 +216,7 @@ public func confirmation<R>(
fatalError("Unsupported")
}

/// An overload of ``confirmation(_:expectedCount:isolation:sourceLocation:_:)-6bkl6``
/// An overload of ``confirmation(_:expectedCount:isolation:sourceLocation:_:)-l3il``
/// that handles the partial-range-up-to operator (`..<n`).
///
/// This overload is necessary because the lower bound of `PartialRangeUpTo` is
Expand Down
8 changes: 4 additions & 4 deletions Sources/Testing/Issues/Issue.swift
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public struct Issue: Sendable {
/// ``Confirmation/confirm(count:)`` should have been called.
///
/// This issue can occur when calling ``confirmation(_:expectedCount:isolation:sourceLocation:_:)-5mqz2``
/// or ``confirmation(_:expectedCount:isolation:sourceLocation:_:)-6bkl6``
/// or ``confirmation(_:expectedCount:isolation:sourceLocation:_:)-l3il``
/// when the confirmation passed to these functions' `body` closures is
/// confirmed too few or too many times.
indirect case confirmationMiscounted(actual: Int, expected: any RangeExpression & Sendable)
Expand Down Expand Up @@ -306,9 +306,9 @@ extension Issue.Kind {
/// ``Confirmation/confirm(count:)`` should have been called.
///
/// This issue can occur when calling
/// ``confirmation(_:expectedCount:isolation:sourceLocation:_:)`` when the
/// confirmation passed to these functions' `body` closures is confirmed too
/// few or too many times.
/// ``confirmation(_:expectedCount:isolation:sourceLocation:_:)-5mqz2`` when
/// the confirmation passed to these functions' `body` closures is confirmed
/// too few or too many times.
indirect case confirmationMiscounted(actual: Int, expected: Int)

/// An issue due to an `Error` being thrown by a test function and caught by
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# ``Testing/confirmation(_:expectedCount:isolation:sourceLocation:_:)-l3il``

@Metadata {
@Available(Swift, introduced: 6.1)
}
2 changes: 1 addition & 1 deletion Sources/Testing/Testing.docc/Expectations.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ the test when the code doesn't satisfy a requirement, use

- <doc:testing-asynchronous-code>
- ``confirmation(_:expectedCount:isolation:sourceLocation:_:)-5mqz2``
- ``confirmation(_:expectedCount:isolation:sourceLocation:_:)-6bkl6``
- ``confirmation(_:expectedCount:isolation:sourceLocation:_:)-l3il``
- ``Confirmation``

### Retrieving information about checked expectations
Expand Down
Loading