Skip to content

Commit 6244644

Browse files
committed
Update docs for more overloads
1 parent 17b7ce0 commit 6244644

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

Sources/Testing/Attachments/Attachment.swift

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -290,13 +290,13 @@ extension Attachment where AttachableValue: Sendable & ~Copyable {
290290
/// derive a reasonable filename for the attached value.
291291
/// - sourceLocation: The source location of the call to this function.
292292
///
293-
/// When attaching a value of a type that does not conform to both
294-
/// [`Sendable`](https://developer.apple.com/documentation/swift/sendable) and
295-
/// [`Copyable`](https://developer.apple.com/documentation/swift/copyable),
296-
/// the testing library encodes it as data immediately. If the value cannot be
297-
/// encoded and an error is thrown, that error is recorded as an issue in the
298-
/// current test and the attachment is not written to the test report or to
299-
/// disk.
293+
/// When `attachableValue` is an instance of a type that does not conform to
294+
/// the [`Sendable`](https://developer.apple.com/documentation/swift/sendable)
295+
/// protocol, the testing library encodes it as data immediately. If
296+
/// `attachableValue` throws an error when the testing library attempts to
297+
/// encode it, the testing library records that error as an issue in the
298+
/// current test and does not write the attachment to the test report or to
299+
/// persistent storage.
300300
///
301301
/// This function creates a new instance of ``Attachment`` and immediately
302302
/// attaches it to the current test.
@@ -318,12 +318,13 @@ extension Attachment where AttachableValue: ~Copyable {
318318
/// - attachment: The attachment to attach.
319319
/// - sourceLocation: The source location of the call to this function.
320320
///
321-
/// When attaching a value of a type that does not conform to the
322-
/// [`Sendable`](https://developer.apple.com/documentation/swift/sendable)
323-
/// protocol, the testing library encodes it as data immediately. If the value
324-
/// cannot be encoded and an error is thrown, that error is recorded as an
325-
/// issue in the current test and the attachment is not written to the test
326-
/// report or to disk.
321+
/// When `attachableValue` is an instance of a type that does not conform to
322+
/// the [`Sendable`](https://developer.apple.com/documentation/swift/sendable)
323+
/// protocol, the testing library encodes it as data immediately. If
324+
/// `attachableValue` throws an error when the testing library attempts to
325+
/// encode it, the testing library records that error as an issue in the
326+
/// current test and does not write the attachment to the test report or to
327+
/// persistent storage.
327328
///
328329
/// @Metadata {
329330
/// @Available(Swift, introduced: 6.2)

0 commit comments

Comments
 (0)