Skip to content

Conversation

QuietMisdreavus
Copy link
Contributor

@QuietMisdreavus QuietMisdreavus commented Apr 19, 2022

Bug/issue #, if applicable: rdar://92124246

Summary

This PR uses an in-progress branch of swift-docc-symbolkit that supplies new ivar and macro 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.

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

@QuietMisdreavus
Copy link
Contributor Author

@swift-ci Please test

@QuietMisdreavus
Copy link
Contributor Author

@swift-ci Please test

Copy link
Contributor

@ethan-kusters ethan-kusters left a 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?

@ethan-kusters
Copy link
Contributor

Should we add some test fixtures that include ivars and macros to verify this behavior?

Oh just seeing this:

(help wanted: is there a good place to add tests for 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.

@QuietMisdreavus
Copy link
Contributor Author

I've added a sample symbol graph and a test that makes sure its curation is correct.

@swift-ci Please test

Copy link
Contributor

@ethan-kusters ethan-kusters left a 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",
Copy link
Contributor

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?

@QuietMisdreavus
Copy link
Contributor Author

I've updated the PR to point back to SymbolKit's main branch, now that swiftlang/swift-docc-symbolkit#30 has landed.

@swift-ci Please test

@QuietMisdreavus
Copy link
Contributor Author

@swift-ci Please test macOS

@QuietMisdreavus QuietMisdreavus merged commit df272bf into swiftlang:main Apr 23, 2022
@QuietMisdreavus QuietMisdreavus deleted the ivar-macro branch April 23, 2022 01:49
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.

2 participants