Skip to content

Prefer using raw identifiers over display name parameters for tests and suites. #1158

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

iamleeg
Copy link
Contributor

@iamleeg iamleeg commented Jun 16, 2025

Fixes #894.

Describes naming types and functions with readable names, instead of overriding their names with macro parameters.

Motivation:

People use the display name parameters to @Test and @Suite to override the names of their test functions and suites with readable display names. That's still possible, but it's more direct to give things readable names in the first place, so let's explain how to do that.

Modifications:

Documentation changes to demonstrate naming things with raw identifiers.
Hints in the @Suite and @Test documentation to prefer raw identifiers over changing display names.

Checklist:

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

@grynspan grynspan added documentation 📚 Improvements or additions to documentation enhancement New feature or request labels Jun 16, 2025
@grynspan grynspan added this to the Swift 6.x milestone Jun 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📚 Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update documentation to discuss raw identifiers.
2 participants