Make MacCatalyst availability information mirror iOS. #962
Conversation
This file contains 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
If a symbol has not defined a explicit availability version for Catalyst, but it has explicit availability for iOS. mirror the iOS version. This is necessary since iOS and Catalyst should always match unless explicitly specified otherwise in the API. rdar://129785705
|
@swift-ci please test |
1 similar comment
|
@swift-ci please test |
|
@swift-ci please test |
|
@swift-ci please test |
d-ronnqvist
reviewed
Jun 27, 2024
Tests/SwiftDocCTests/Infrastructure/SymbolGraph/SymbolGraphLoaderTests.swift
Outdated
Show resolved
Hide resolved
Tests/SwiftDocCTests/Infrastructure/SymbolGraph/SymbolGraphLoaderTests.swift
Outdated
Show resolved
Hide resolved
Tests/SwiftDocCTests/Infrastructure/SymbolGraph/SymbolGraphLoaderTests.swift
Outdated
Show resolved
Hide resolved
Tests/SwiftDocCTests/Infrastructure/SymbolGraph/SymbolGraphLoaderTests.swift
Outdated
Show resolved
Hide resolved
Sources/SwiftDocC/Infrastructure/Symbol Graph/SymbolGraphLoader.swift
Outdated
Show resolved
Hide resolved
Sources/SwiftDocC/Infrastructure/Symbol Graph/SymbolGraphLoader.swift
Outdated
Show resolved
Hide resolved
Sources/SwiftDocC/Infrastructure/Symbol Graph/SymbolGraphLoader.swift
Outdated
Show resolved
Hide resolved
anferbui
reviewed
Jun 27, 2024
Sources/SwiftDocC/Infrastructure/Symbol Graph/SymbolGraphLoader.swift
Outdated
Show resolved
Hide resolved
…morales/swift-docc into 129785705/infer-ios-for-catalyst
sofiaromorales
force-pushed
the
129785705/infer-ios-for-catalyst
branch
from
a074826
to
f82cb12
Compare
|
@swift-ci please test |
anferbui
approved these changes
Jul 4, 2024
| let defaultAvailabilityIntroducedVersion = defaultAvailabilities.first(where: { $0.platformName == fallbackPlatform })?.introducedVersion | ||
| else { return } | ||
| // Ensure that the availability version is not overwritten if the symbol has an explicit availability annotation for that platform. | ||
| if SymbolGraph.SemanticVersion(string: defaultAvailabilityIntroducedVersion) == fallbackAvailabilityIntroducedVersion { |
There was a problem hiding this comment.
More of a discussion point than something to tackle in this PR, is there a reason we store DefaultAvailability.introducedVersion as a string rather than a semantic version type such as SemanticVersion? I think it would be useful to have one semantic version type which we use everywhere we reference platform build versions, similar to the discussion in #970
|
@swift-ci please test |
sofiaromorales
added a commit
to sofiaromorales/swift-docc
that referenced
this pull request
Jul 9, 2024
Make MacCatalyst availability information mirror iOS. If a symbol has not defined an explicit availability version for Catalyst, but it has explicit availability for iOS. mirror the iOS version. This is necessary since iOS and Catalyst should always match unless explicitly specified otherwise in the API. rdar://129785705
sofiaromorales
added a commit
that referenced
this pull request
Jul 10, 2024
Make MacCatalyst availability information mirror iOS. If a symbol has not defined an explicit availability version for Catalyst, but it has explicit availability for iOS. mirror the iOS version. This is necessary since iOS and Catalyst should always match unless explicitly specified otherwise in the API. rdar://129785705
Sign up for free
to 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: 129785705
Summary
This PR makes a symbol that has not defined a explicit availability version for Catalyst, but it has explicit availability for iOS, mirror the iOS version.
This is necessary since iOS and Catalyst should usually match version information, unless it's explicitly specified otherwise in the API using the available attribute.
Dependencies
N/A
Testing
Steps:
129785705.docc.zip
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded