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

Improve the ergonomics of working with the Symbol.Availability.Domain constants #90

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

d-ronnqvist
Copy link
Contributor

Bug/issue #, if applicable:

Summary

This improves the ergonomics of creating Symbol.Availability.Domain values for known constants.

Currently, because the constants are string values, creating a domain value for a known domain looks like:

let domain = Symbol.Availability.Domain(rawValue: Symbol.Availability.Domain.macOS)

with these changes, creating the same domain value looks like:

let domain = Symbol.Availability.Domain.macOS

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:

public static let swiftDomain = Domain(rawValue: "Swift")
@available(*, deprecated, renamed: "swiftDomain", message: "Use 'swiftDomain' instead. This deprecated API will be removed after 6.2 is released")
public static let swift = "Swift"

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.

  • Added tests
  • Ran the ./bin/test script and it succeeded
  • Updated documentation if necessary

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 this pull request may close these issues.

1 participant