-
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
[5.7] use new ivar/macro symbol kinds #156
[5.7] use new ivar/macro symbol kinds #156
Conversation
@swift-ci Please test |
Package.swift
Outdated
@@ -124,7 +124,7 @@ if ProcessInfo.processInfo.environment["SWIFTCI_USE_LOCAL_DEPS"] == nil { | |||
.package(name: "swift-markdown", url: "https://github.com/apple/swift-markdown.git", .branch("main")), | |||
.package(name: "CLMDB", url: "https://github.com/apple/swift-lmdb.git", .branch("main")), | |||
.package(url: "https://github.com/apple/swift-argument-parser", .upToNextMinor(from: "1.0.1")), | |||
.package(name: "SymbolKit", url: "https://github.com/apple/swift-docc-symbolkit", .branch("main")), | |||
.package(name: "SymbolKit", url: "https://github.com/apple/swift-docc-symbolkit", .branch("revert-25-revert-23-5.7/objc-kinds")), |
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.
When we update this to point at release/5.7
can we also update CLMDB
and swift-markdown
to point at release/5.7
and re-resolve dependencies? This shouldn't change the commit hash since main
and release/5.7
point to the same commit but we should still be pointing to the correct branch here.
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.
Yeah! I can do that once i land the SymbolKit PR.
7e60590
to
21fb887
Compare
f70e609
to
58adcf5
Compare
I've updated the PR to point back at SymbolKit's @swift-ci Please test |
@swift-ci Please test macOS |
This is a cherry-pick of #152 onto
release/5.7
.Explanation: A change in SymbolKit (swiftlang/swift-docc-symbolkit#31) is adding new symbol kinds: ivar and macro. This change updates DocC to handle these new symbols and curate them within rendered documentation.
Scope: Adds new behavior to load and curate new symbol types. Existing documentation should render with no change in behavior.
Radar: rdar://92124246
Risk: Low. This is a small enhancement without changing existing behavior for loading and curating symbols.
Testing: A new automated test has been added to ensure that the new symbol kinds can be loaded and organized into the documentation hierarchy correctly.