-
Notifications
You must be signed in to change notification settings - Fork 154
use new ivar/macro symbol kinds #152
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
Conversation
@swift-ci Please test |
e969ef1
to
c992981
Compare
@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.
Should we add some test fixtures that include ivars and macros to verify this behavior?
Oh just seeing this:
Maybe @d-ronnqvist has ideas but I would start with just adding a minimal symbol graph that includes these types and asserting that the auto-curation works as expected. |
c992981
to
e9f9a36
Compare
I've added a sample symbol graph and a test that makes sure its curation is correct. @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.
Looks great!
Package.resolved
Outdated
@@ -41,8 +41,8 @@ | |||
"package": "SymbolKit", | |||
"repositoryURL": "https://github.com/apple/swift-docc-symbolkit", | |||
"state": { | |||
"branch": "main", | |||
"revision": "ed8ce5502e563090ab1400b4dd7d703b01eceabb", | |||
"branch": "revert-24-revert-21-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.
I guess we can land the SymbolKit PR first and re-run CI here since its backwards compatible?
e9f9a36
to
a65b9d6
Compare
I've updated the PR to point back to SymbolKit's @swift-ci Please test |
@swift-ci Please test macOS |
Bug/issue #, if applicable: rdar://92124246
Summary
This PR uses an in-progress branch of swift-docc-symbolkit that supplies new
ivar
andmacro
symbol kinds to provide new curation headings and symbol page kinds for these symbols. The symbol kinds already existed, so this PR merely hooks up the new kinds to the existing work.Dependencies
swiftlang/swift-docc-symbolkit#30
Testing
As part of a complete toolchain, process an Objective-C symbol graph that includes instance variables and/or macro definitions. Ensure that these symbols correctly appear in the documentation hierarchy and with correct symbol page organization.
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/test
script and it succeeded