Render 'Details' section with property list key information. #987
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
To better support the documentation of property list keys this adds the a new section (Details) that renders the mixin information for the key 'plistDetails'. This is used to better describe property list keys in a human-friendly way. rdar://131373480
…morales/swift-docc into 131373480/render-details-section
d-ronnqvist
reviewed
Jul 16, 2024
Sources/SwiftDocC/Model/Rendering/RenderSectionTranslator/PlistDetailsSectionTranslator.swift
Outdated
Show resolved
Hide resolved
Sources/SwiftDocC/Model/Rendering/RenderSectionTranslator/PlistDetailsSectionTranslator.swift
Outdated
Show resolved
Hide resolved
Tests/SwiftDocCTests/Rendering/PlistDetailsRenderSectionTests.swift
Outdated
Show resolved
Hide resolved
Tests/SwiftDocCTests/Rendering/PlistDetailsRenderSectionTests.swift
Outdated
Show resolved
Hide resolved
d-ronnqvist
reviewed
Jul 16, 2024
|
@swift-ci please test |
d-ronnqvist
approved these changes
Jul 18, 2024
…morales/swift-docc into 131373480/render-details-section
|
@swift-ci please test |
…morales/swift-docc into 131373480/render-details-section
…morales/swift-docc into 131373480/render-details-section
|
@swift-ci please test |
|
@swift-ci please test |
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Bug/issue #, if applicable: rdar://131373480
Summary
Add a translator to render the already existing Details section. This section will display the data of the new SymbolKit mixin
plistDetails.The Details section contains:
1.Type - Type of the symbol.
2. Key (optional) - Name of the symbol if the title of the page is overwritten and does not shows the key name.
3. Name (optional) - A human-readable name of the key.
Details section displaying the human-readable name:
Details section displaying the key name:
Dependencies
This change depends on a new commit of SymbolKit.
Testing
Steps:
plist.docc.zip
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded