Provide prose documentation for attachments. #1413
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This PR adds prose documentation explaining how to create attachments and add them to tests. Resolves #1143.
grynspan
requested review from
briancroom,
jerryjrchen and
stmontgomery
as code owners
grynspan
added
documentation
grynspan
commented
Nov 11, 2025
| /// | ||
| /// - ``Trait/savingAttachments(if:)`` | ||
| /// | ||
| /// By default, the testing library saves your attachments as soon as you call |
Contributor
Author
There was a problem hiding this comment.
This file is all SPI.
Contributor
Author
|
Tracked internally as rdar://164478451. |
Comment on lines
+184
to
+186
| - When using Swift Package Manager's `swift test` command, you can pass the | ||
| `--attachments-path` option. The testing library saves attachments to the | ||
| specified directory. |
Contributor
There was a problem hiding this comment.
Can we clarify that if this CLI flag is not passed, attachments will not be saved anywhere? I wonder if that's even worth an "Important" callout or similar
Contributor
Author
There was a problem hiding this comment.
I'm going to leave it as-is and let our DevPubs colleagues consider how to phrase it.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds prose documentation explaining how to create attachments and add them to tests.
Resolves #1143.
Checklist: