-
Notifications
You must be signed in to change notification settings - Fork 127
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
Beta tag heuristic should use >= when comparing platform version information #994
Beta tag heuristic should use >= when comparing platform version information #994
Conversation
@swift-ci Please test |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks great, thanks!
Sources/SwiftDocC/Model/Rendering/DocumentationContentRenderer.swift
Outdated
Show resolved
Hide resolved
Minor: Specify the beta behaviour in the
|
Sources/SwiftDocC/Infrastructure/External Data/ExternalMetadata.swift
Outdated
Show resolved
Hide resolved
Sources/SwiftDocC/Model/Rendering/DocumentationContentRenderer.swift
Outdated
Show resolved
Hide resolved
@swift-ci please test |
1 similar comment
@swift-ci please test |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need this?
or equal to the current platform, if the current platform is beta.
VersionTriplet and to SemanticVersion by changing two call sites.
e7f7a25
to
8d31573
Compare
@swift-ci please test |
rdar://132024975
Summary
Today DocC Render displays a beta badge for symbols that were introduced in the current version of a platform, if the platform's availability was set as beta in the DocC compiler command line invocation.
This change updates this heuristic to consider symbols that were introduced in the current - or future - version of a beta platform. This gives DocC a bit more flexibility to handle symbol data that might describe future versions of a platform, and to handle platforms that might have two versions in beta at the same time.
Dependencies
None.
Testing
Steps:
--platform name=myPlatform,version=3.0.0,beta=true
myPlatform 3.0+ Beta
--platform name=myPlatform,version=1.0.0,beta=true
myPlatform 3.0+ Beta
, even though the symbol was introduced in a later version of the beta platform.Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/test
script and it succeeded[ ] Updated documentation if necessary