Skip to content
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

Display entitlement key in symbol reference #1018

Merged

Conversation

sofiaromorales
Copy link
Contributor

Bug/issue #, if applicable: 129540266

Summary

Property list keys that define a human readable title (#987) should show the key name under the abstract when referenced form another symbol.

This pr adds the implementation to get this working by passing the property list key information to the topic render reference.

Dependencies

N/A

Testing

Steps:

  1. Preview the attached docc archive.
  2. Assert that in the top level page, the foo symbol displays the key name under the abstract section.

plistkey.docc.zip

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
  • Updated documentation if necessary

When referencing a symbol in a topics section, if the symbol is a property that contains a key and a custom title, display the key name under the abstract.

rdar://129540266
@sofiaromorales sofiaromorales changed the title 129540266/entitlement key Display entitlement key in symbol reference Sep 3, 2024
Copy link
Contributor

@d-ronnqvist d-ronnqvist left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The fix looks good but I think we should avoid the repetition in the test.

Copy link
Contributor

@d-ronnqvist d-ronnqvist left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@sofiaromorales
Copy link
Contributor Author

@swift-ci please test

@sofiaromorales sofiaromorales merged commit ac5ba29 into swiftlang:main Sep 4, 2024
2 checks passed
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