Link Swift Testing documentation in its test template

[jerryjrchen]

Link Swift Testing documentation in its test template

Motivation:

This hopefully makes it easier for new users to find relevant documentation for our test framework!

It also matches the existing pattern where XCTest documentation is linked in its respective test template.

Modifications:

• Add a link to Swift Testing documentation in the test template.
• Trims some trailing whitespace. Realistically, I don't have much control over this since my editor is respecting the project's .editorconfig's trim_trailing_whitespace = true directive. I can manually put them back if that would be better.

Result:

Default Swift Testing template will include a comment linking to the developer docs.

Testing it locally:

~/scraps/autogen/xx.ZtJsA ❯ /Users/jerrychen/workspace/opensource/swift-package-manager/.build/arm64-apple-macosx/debug/swift-package init
Creating library package: xx.ZtJsA
Creating Package.swift
Creating .gitignore
Creating Sources
Creating Sources/xx.ZtJsA/xx_ZtJsA.swift
Creating Tests/
Creating Tests/xx.ZtJsATests/
Creating Tests/xx.ZtJsATests/xx_ZtJsATests.swift
~/scraps/autogen/xx.ZtJsA ❯ /bin/cat Tests/xx.ZtJsATests/xx_ZtJsATests.swift
import Testing
@testable import xx_ZtJsA

@Test func example() async throws {
    // Write your test here and use APIs like `#expect(...)` to check expected conditions.
    // Swift Testing Documentation
    // https://developer.apple.com/documentation/testing
}

[grynspan]

Is there an equivalent link on swift.org we could use?

[jerryjrchen]

Is there an equivalent link on swift.org we could use?

Closest I could find is https://www.swift.org/documentation/core-libraries/#swift-testing, which transitively links to the Swift Testing GitHub repo.

[bkhouri]

issue (blocking): I love this and completely support it. Though,I have been disappointed (for a lack of a better word) previously while inspecting the Apple XCTest documentation when targeting non-Apple devices as the XCTest API is not identical on macOS and Linux. Although I suspect this is not the case with Swift Testing, my experience has lead me to not have confidence that the developer.apple.com documentation will be valid on non-apple platforms.

Can the link point to the Swift.org Swift Testing API. If that documentation is not published, I would say updating the template is gating upon that.

[grynspan]

Though,I have been disappointed (for a lack of a better word) previously while inspecting the Apple XCTest documentation when targeting non-Apple devices as the XCTest API is not identical on macOS and Linux.

Feel free to open a PR, although I have no idea where you'd do so.

[grynspan]

Can the link point to the Swift.org Swift Testing API. If that documentation is not published, I would say updating the template is gating upon that.

Could we link to swiftpackageindex.com? There's a copy of the documentation hosted there.