- Notifications
You must be signed in to change notification settings - Fork45
Improve the ergonomics of working with theSymbol.Availability.Domain constants#90
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Open
d-ronnqvist wants to merge1 commit intoswiftlang:mainChoose a base branch fromd-ronnqvist:domain-ergonomics
base:main
Could not load branches
Branch not found:{{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
Uh oh!
There was an error while loading.Please reload this page.
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Bug/issue #, if applicable:
Summary
This improves the ergonomics of creating
Symbol.Availability.Domainvalues for known constants.Currently, because the constants are string values, creating a domain value for a known domain looks like:
with these changes, creating the same domain value looks like:
Warning
This is an API breaking change
I tried to avoid making API breaking changes here but I didn't really like any of the alternatives. The least bad workaround I could think of was:
What I don't like about it is that after the 6.2 release we're either going to have API that doesn't follow Swift's API Design Guidelines (because it repeats the type name in the property name) or we're going to have to deprecate it again to rename it back to just "swift".
I have some hopes that this API is nearly unused in practice because the current ergonomics are so bad that I'd expect that someone would have complained about it if anyone was using it.
Dependencies
This doesn't depend on anything but it's a breaking change for other repos.
Testing
Nothing in particular. This isn't a user-facing change.
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded