Skip to content

Hoist Attachment and Attachable out of Test. #821

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 1 commit into from
Nov 13, 2024

Conversation

grynspan
Copy link
Contributor

@grynspan grynspan commented Nov 13, 2024

I initially placed these types inside Test out of concern that they could conflict with symbols in second- or third-party modules that are being tested. After discussing with my colleagues, we've decided to hoist the types up to the top level of the Testing module.

There's no general solution for name conflicts in Swift other than providing the module name at point-of-use, and by and large the language, toolchain, and Apple's frameworks just sort of accept this possibility? So I was maybe overthinking it. If we run into trouble down the line before release, we can reevaluate this decision.

Checklist:

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

I initially placed these types inside `Test` out of concern that they could
conflict with symbols in second- or third-party modules that are being tested.
After discussing with my colleagues, we've decided to hoist the types up to the
top level of the Testing module.

There's no general solution for name conflicts in Swift other than providing the
module name at point-of-use, and by and large the language, toolchain, and
Apple's frameworks just sort of accept this possibility? So I was maybe
overthinking it. If we run into trouble down the line before release, we can
reevaluate this decision.
@grynspan grynspan added public-api Affects public API attachments/activities 🖇️ Work related to attachments and/or activities labels Nov 13, 2024
@grynspan grynspan added this to the Swift 6.1 milestone Nov 13, 2024
@grynspan grynspan self-assigned this Nov 13, 2024
@grynspan
Copy link
Contributor Author

Preemptively declaring this as reviewed by @briancroom and @stmontgomery as they already signed off on these renames privately. 😈

@grynspan
Copy link
Contributor Author

@swift-ci test

@grynspan grynspan merged commit 17209c0 into main Nov 13, 2024
3 checks passed
@grynspan grynspan deleted the jgrynspan/hoist-attachment-types branch November 13, 2024 14:15
grynspan added a commit that referenced this pull request Nov 13, 2024
grynspan added a commit that referenced this pull request Nov 13, 2024
Follow-up to #821.

### Checklist:

- [x] Code and documentation should follow the style of the [Style
Guide](https://github.com/apple/swift-testing/blob/main/Documentation/StyleGuide.md).
- [x] If public symbols are renamed or modified, DocC references should
be updated.
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 public-api Affects public API
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant