New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Support disambiguating links with type signature information #643
base: main
Are you sure you want to change the base?
Support disambiguating links with type signature information #643
Conversation
# Conflicts: # Tests/SwiftDocCTests/Infrastructure/PathHierarchyTests.swift
Co-authored-by: Ethan Kusters <ekusters@apple.com> Co-authored-by: Daniel Grumberg <dgrumberg@apple.com> Co-authored-by: Max Obermeier <themomax@icloud.com> Co-authored-by: Natik Gadzhi <natik@respawn.io>
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. |
0939305
to
4b2581b
Compare
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
9605330
to
3827762
Compare
# 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
The main implementation is ready for review. I will update the user facing documentation to describe this new syntax. |
@swift-ci please test |
Bug/issue #, if applicable: rdar://112224233
Summary
Adds support for disambiguating symbol links with information from the symbol graph's
functionSignature
data.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/test
script and it succeeded