Display entitlement key in symbol reference - Githubissues

swiftlang / swift-docc

Documentation compiler that produces rich API reference documentation and interactive tutorials for your Swift framework or package.

https://swift.org/documentation/docc

Apache License 2.0

1.17k stars 124 forks source link

Display entitlement key in symbol reference #1018

Closed sofiaromorales closed 1 month ago

sofiaromorales commented 1 month ago

Bug/issue #, if applicable: 129540266

Summary

Property list keys that define a human readable title (https://github.com/swiftlang/swift-docc/pull/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:

Preview the attached docc archive.
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.

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

sofiaromorales commented 1 month ago

@swift-ci please test