Skip to content

Conversation

grynspan
Copy link
Contributor

@grynspan grynspan commented Aug 11, 2025

Enhance documentation for Attachment.init(contentsOf:named:sourceLocation:). In particular, provide info on what kind of URLs can be passed in, what the initializer awaits on, and how to use this (since there's intentionally no equivalent record() overload.)

Resolves #1255.

Checklist:

  • Code and documentation should follow the style of the Style Guide.
  • If public symbols are renamed or modified, DocC references should be updated.

Enhance documentation for [`Attachment.init(contentsOf:named:sourceLocation:)`](https://developer.apple.com/documentation/testing/attachment/init(contentsof:named:sourcelocation:)). In particular, provide info on what kind of URLs can be passed in, what the initializer awaits on, and how to use this (since there's intentionally no equivalent `record()` overload.)

Resolves #1255.
@grynspan grynspan added this to the Swift 6.x (main) milestone Aug 11, 2025
@grynspan grynspan requested a review from stmontgomery as a code owner August 11, 2025 17:11
@grynspan grynspan added the documentation 📚 Improvements or additions to documentation label Aug 11, 2025
@grynspan grynspan added attachments/activities 🖇️ Work related to attachments and/or activities cross-import-overlays 🍰 Cross-import overlays (Foundation, Core Graphics, etc.) labels Aug 11, 2025
Copy link
Contributor

@iamleeg iamleeg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, just a few suggestions.

@grynspan grynspan requested a review from iamleeg August 12, 2025 15:54
@grynspan
Copy link
Contributor Author

@swift-ci test

@grynspan grynspan merged commit a68a681 into main Aug 12, 2025
3 checks passed
@grynspan grynspan deleted the jgrynspan/1255-url-init-docs branch August 12, 2025 17:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
attachments/activities 🖇️ Work related to attachments and/or activities cross-import-overlays 🍰 Cross-import overlays (Foundation, Core Graphics, etc.) documentation 📚 Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enhance documentation for URL attachments
3 participants