8000 Document/Improve Swift language version support · Issue #7121 · CocoaPods/CocoaPods · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Document/Improve Swift language version support #7121

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

Closed
1 task done
thomasvl opened this issue Oct 10, 2017 · 5 comments · Fixed by #7131
Closed
1 task done

Document/Improve Swift language version support #7121

thomasvl opened this issue Oct 10, 2017 · 5 comments · Fixed by #7131

Comments

@thomasvl
Copy link

Report

What did you do?

The docs for publishing a pod don't really talk at all about .swift-version, but trying to run lint or push the pod can kick out warnings about it. But if one trying to find out more about the file, there is no clear info in the official docs. Even if you use the --swift-version command line arg, you still get warnings telling you to create the file, and the warning goes no indication that the command line arg was honored.

If the pod is really for a Swift project, odds are they are going support multiple versions of Swift (since the language is stabilizing and there are #swift() conditionals, it is very doable), having the file can make some developers think that version is required.

So better docs about what this file is would help for people who thing this implies something about the pod; likewise, docs in generally acknowledging how Swift versions come into play with pods would be welcomed.

Project that demonstrates the issue

On https://github.com/apple/swift-protobuf we're support back "one full major version" (so Swift 3.0.1 thru 4 currently).

@orta
Copy link
Member
orta commented Oct 10, 2017

We're definitely happy to accept PRs improving the documentation 👍

@thomasvl
Copy link
Author

We're definitely happy to accept PRs improving the documentation 👍

I have to admit at the moment, I'm not even clear when the file should/shouldn't be used. So I'm not sure what to suggest for improvements. 😦

@dnkoutso
Copy link
Contributor

@thomasvl at least for starters we can suppress the warning message if --swift-vesion was supplied.

@dnkoutso
Copy link
Contributor
dnkoutso commented Oct 12, 2017

@thomasvl FWIW we are planning on introducing DSL inside the podspec for 1.4.0 in which specifies the versions of Swift a pod supports.

I think in the meantime I will probably make a small improvement to close this issue around the redundant warning outputted even if Swift version was set.

See #6791

@thomasvl
Copy link
Author

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants
0