Skip to content
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

Requirement for a 6.0 development toolchain: stale docs? #846

Open
tristanlabelle opened this issue Dec 10, 2024 · 1 comment
Open

Requirement for a 6.0 development toolchain: stale docs? #846

tristanlabelle opened this issue Dec 10, 2024 · 1 comment
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@tristanlabelle
Copy link

tristanlabelle commented Dec 10, 2024

Description

The Readme states:

This package is under active, ongoing development and requires a recent 6.0 development snapshot toolchain.

But since swift-testing is supported with Xcode 16 which ships Swift 6.0, and the current Swift development version is 6.1, I believe this comment is stale and should read that swift-testing requires Swift 6.0 (or whatever the minimum required version is). Could this notice be clarified?

https://github.com/swiftlang/swift-testing?tab=readme-ov-file#documentation

Expected behavior

No response

Actual behavior

No response

Steps to reproduce

No response

swift-testing version/commit hash

No response

Swift & OS version (output of swift --version ; uname -a)

No response

@tristanlabelle tristanlabelle added the bug Something isn't working label Dec 10, 2024
@grynspan
Copy link
Contributor

The comment is still correct(ish) as it's describing the package, not the copy included in the toolchain. The main branch of the package requires either a main-branch or 6.1-branch Swift toolchain to use (anything else might work but is wholly unsupported.)

We should finesse the docs to make that clear.

@grynspan grynspan added the documentation Improvements or additions to documentation label Dec 10, 2024
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
Projects
None yet
Development

No branches or pull requests

2 participants