swiftlang / swiftlang/swift-testing
Update documentation to discuss raw identifiers.
Open
@iamleeg is already working on this.
Since Jan 7, 2025.
documentation
enhancement
raw-identifiers
- Dominant language
- Swift
- Stars
- 2.2k
- Forks
- 169
- Avg merge
- 1d 18h
- Merged PRs (30d)
- 56
Description
We need to update our documentation, especially around @Suite and @Test, to discuss raw identifiers in place of the displayName argument. In particular, where we currently recommend something like:
@Test("foo bar baz") func f() { ... }
We probably want to offer this instead:
@Test func `foo bar baz`() { ... }
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.