Highlight unique components of overloaded declarations #841
Conversation
This file contains hidden or 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
…nents-of-overloaded-declarations
|
@swift-ci test |
2 tasks
…nents-of-overloaded-declarations
|
Marking this as a draft, because it sounds like the swift-docc design for the Render JSON may change |
…nents-of-overloaded-declarations
marinaaisa
reviewed
Jun 3, 2024
| </template> | ||
|
|
||
| <script> | ||
| export default { name: 'Highlighted' }; |
There was a problem hiding this comment.
Maybe in the future we can reuse this component for other highlighting context like codeListing to unify all these logics in some way. I know it doesn't look easy
marinaaisa
approved these changes
Jun 3, 2024
|
Re-opening this, because it sounds like we're going to actually go with this approach for now and later make the change to what is in #847 😅 |
|
@swift-ci test |
mportiz08
added a commit
to mportiz08/swift-docc-render
that referenced
this pull request
Jun 3, 2024
Resolves: rdar://128997251 Co-authored-by: Vera Mitchell <[email protected]>
marinaaisa
pushed a commit
that referenced
this pull request
Jun 4, 2024
Resolves: rdar://128997251 Co-authored-by: Vera Mitchell <[email protected]>
This was referenced Jun 28, 2024
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: 117503463
Summary
Adds support for highlighting the unique components of overloaded declarations through a new, recursive declaration token component. These highlighted tokens will only be visually rendered when a group of overloaded symbols have been expanded by the user.
Example
Here, the highlights emphasize that this function is overloaded by the type of its only parameter.
Dependencies
swift-docc: Highlight declaration differences in overloaded symbol groups #928Testing
Steps:
npm run buildswift-doccfrom this PR and runswift buildDOCC_HTML_DIR=/path/to/swift-docc-render/dist swift run docc preview --enable-experimental-overloaded-symbol-presentation Tests/SwiftDocCTests/Test\ Bundles/OverloadedSymbols.doccChecklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
npm test, and it succeeded\cc @QuietMisdreavus