Skip to content

Update outdated Suite macro documentation #1142

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
Jun 8, 2025

Conversation

Wouter01
Copy link
Contributor

@Wouter01 Wouter01 commented Jun 7, 2025

Remove the doc stating that the @Suite macro only works on Copyable types.

Motivation:

When reading through the docs, I was quite confused seeing it stated that ~Copyable types aren't supported by the @Suite macro, whereas it does work when doing so. I had a look at it looks like that restriction has been lifted by #619, but the docs weren't updated.

Modifications:

Updated the docs

Checklist:

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

@stmontgomery stmontgomery added bug 🪲 Something isn't working documentation 📚 Improvements or additions to documentation macros 🔭 Related to Swift macros such as @Test or #expect labels Jun 8, 2025
@stmontgomery stmontgomery added this to the Swift 6.x milestone Jun 8, 2025
@stmontgomery
Copy link
Contributor

@swift-ci Please test

Copy link
Contributor

@stmontgomery stmontgomery left a comment

Choose a reason for hiding this comment

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

Makes sense to me, thanks

@grynspan
Copy link
Contributor

grynspan commented Jun 8, 2025

Ship it!

@stmontgomery stmontgomery merged commit 25b61ef into swiftlang:main Jun 8, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug 🪲 Something isn't working documentation 📚 Improvements or additions to documentation macros 🔭 Related to Swift macros such as @Test or #expect
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants