search

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

Fix property list key/name reference. #1046

Closed sofiaromorales closed 2 days ago

sofiaromorales commented 3 days ago

Bug/issue #, if applicable: 137113068

Summary

Fix property list key/name reference.

When curating a property list key that is extended and contains a custom display name on the SGF, the key path is displayed twice: once as the link name and again under the symbol abstract.

Screenshot 2024-10-03 at 19 52 01

This implementation displays the property list custom name under the symbol abstract when curated.

Dependencies

Describe any dependencies this PR might have, such as an associated branch in another repository.

Testing

plist-2.docc.zip

Steps:

  1. Preview the attached catalog.
  2. Assert that under the curation at the top level page the symbols are displaying the custom key name as expected.
Screenshot 2024-10-03 at 19 54 02

Checklist

Make sure you check off the following items. If they cannot be completed, provide a reason.

patshaughnessy commented 2 days ago

@swift-ci please test

sofiaromorales commented 2 days ago

@swift-ci please test