Add new typeDetails symbol mixin
#56
Merged
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
…ed dictionary keys and HTTP parameters.
|
@swift-ci please test |
3 tasks
QuietMisdreavus
approved these changes
Mar 31, 2023
|
@swift-ci please test |
pdwilson12
added a commit
to pdwilson12/swift-docc-symbolkit
that referenced
this pull request
Mar 31, 2023
…ed dictionary keys and HTTP parameters. (swiftlang#56) Co-authored-by: Peter Wilson <pwilson@apple.com>
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
Add new
typeDetailssymbol mixin to hold type details of weakly-typed dictionary keys and HTTP parameters.JSON structures and HTTP parameters can define fields that can take values of multiple types,
such as integers or strings. The
typeDetailsmixin allows the symbol graph to identify the individual types that are supported. DocC will use this information to list the "Possible types" in the rendered pages for the affected keys and parameters.Dependencies
None.
Testing
To be described in parallel DocC PR.
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded