Process typeDetails information from symbol graphs.
#529
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
Convert data into base-type details and allowed type declarations for `RenderProperty` entities, such as dictionary keys and HTTP parameters.
QuietMisdreavus
approved these changes
Mar 31, 2023
pdwilson12
force-pushed
the
type_details
branch
from
ad3821c
to
cfdf458
Compare
|
@swift-ci please test |
pdwilson12
added a commit
to pdwilson12/swift-docc
that referenced
this pull request
Mar 31, 2023
* Process `typeDetails` information from symbol graphs. Convert data into base-type details and allowed type declarations for `RenderProperty` entities, such as dictionary keys and HTTP parameters. * Update SymbolKit dependency to pick up latest commit.
pdwilson12
added a commit
that referenced
this pull request
Apr 1, 2023
* Process `typeDetails` information from symbol graphs. (#529) * Process `typeDetails` information from symbol graphs. Convert data into base-type details and allowed type declarations for `RenderProperty` entities, such as dictionary keys and HTTP parameters. * Update SymbolKit dependency to pick up latest commit. * Update SymbolKit dependency to point to release/5.9 branch.
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://107432025
Summary
Converts new
typeDetailsinformation in symbol graph into base-type details and allowed type declarations forRenderPropertyentities, such as dictionary keys and HTTP parameters. This data is rendered on the page as part of the key or parameter documentation as a "Possible types" attribute, listing the individual types.Dependencies
Requires changes on
type_detailsbranch of pdwilson12/swift-docc-symbolkit tracked in swiftlang/swift-docc-symbolkit#56Testing
Build docc and preview the DictionaryData.docc fixture bundle.
Steps:
docc previewon theDictionaryData.doccfixtureArtistpage and confirm "Possible types" entry ofmonthOfBirthkey.typeDetailsentry and verify changes reflected on page.Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded