Support disambiguating links with type signature information #643
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
# Conflicts: # Tests/SwiftDocCTests/Infrastructure/PathHierarchyTests.swift
Co-authored-by: Ethan Kusters <[email protected]> Co-authored-by: Daniel Grumberg <[email protected]> Co-authored-by: Max Obermeier <[email protected]> Co-authored-by: Natik Gadzhi <[email protected]>
|
I feel that the code in this PR is getting too long to be easily reviewed but splitting it into multiple files in the same PR makes it much much harder to know what changed and what moved. Because of this I opened #662 to only split the code into multiple files and then this PR can focus on just the new feature. |
d-ronnqvist
force-pushed
the
readable-symbol-link-disambiguation
branch
from
0939305
to
4b2581b
Compare
d-ronnqvist
force-pushed
the
readable-symbol-link-disambiguation
branch
from
4b2581b
to
7341760
Compare
# Conflicts: # Sources/SwiftDocC/Infrastructure/Link Resolution/PathHierarchy+Error.swift # Sources/SwiftDocC/Infrastructure/Link Resolution/PathHierarchy+Find.swift # Sources/SwiftDocC/Infrastructure/Link Resolution/PathHierarchy+PathComponent.swift # Sources/SwiftDocC/Infrastructure/Link Resolution/PathHierarchy.swift # Tests/SwiftDocCTests/Infrastructure/PathHierarchyTests.swift
d-ronnqvist
force-pushed
the
readable-symbol-link-disambiguation
branch
from
9605330
to
3827762
Compare
d-ronnqvist
added
the
merge conflicts
2 tasks
Merged
2 tasks
# Conflicts: # Sources/SwiftDocC/Infrastructure/Link Resolution/PathHierarchy+DisambiguatedPaths.swift # Sources/SwiftDocC/Infrastructure/Link Resolution/PathHierarchy+Error.swift # Sources/SwiftDocC/Infrastructure/Link Resolution/PathHierarchy+Find.swift # Sources/SwiftDocC/Infrastructure/Link Resolution/PathHierarchy+PathComponent.swift # Sources/SwiftDocC/Infrastructure/Link Resolution/PathHierarchy+Serialization.swift # Sources/SwiftDocC/Infrastructure/Link Resolution/PathHierarchy.swift # Tests/SwiftDocCTests/Infrastructure/PathHierarchyTests.swift
d-ronnqvist
removed
the
merge conflicts
|
The main implementation is ready for review. I will update the user facing documentation to describe this new syntax. |
d-ronnqvist
changed the title
|
@swift-ci please test |
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://112224233
Summary
Adds support for disambiguating symbol links with information from the symbol graph's
functionSignaturedata.This new syntax was pitched on the Swift Forums in this thread.
With these changes DocC will support type signature disambiguation in links and will use it in diagnostics but topic references and page URLs will continue to only use kind-and-hash disambiguation to ensure that all pages have the same URLs as without these changes.
Dependencies
None.
Testing
Describe how a reviewer can test the functionality of your PR. Provide test content to test with if
applicable.
Steps:
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded