-
Notifications
You must be signed in to change notification settings - Fork 127
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
Match documentation extensions to symbols using link resolver #565
Merged
d-ronnqvist
merged 8 commits into
swiftlang:main
from
d-ronnqvist:match-doc-extension-with-link-resolver
Apr 27, 2023
Merged
Match documentation extensions to symbols using link resolver #565
d-ronnqvist
merged 8 commits into
swiftlang:main
from
d-ronnqvist:match-doc-extension-with-link-resolver
Apr 27, 2023
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
Also, fix incorrect source url in technology root diagnostic rdar://108392613
rdar://108392639
@swift-ci please test |
This was
linked to
issues
Apr 25, 2023
franklinsch
reviewed
Apr 26, 2023
Tests/SwiftDocCTests/DocumentationService/ConvertService/ConvertServiceTests.swift
Outdated
Show resolved
Hide resolved
@swift-ci please test |
@swift-ci please test |
franklinsch
approved these changes
Apr 27, 2023
Tests/SwiftDocCTests/DocumentationService/ConvertService/ConvertServiceTests.swift
Outdated
Show resolved
Hide resolved
@swift-ci please test |
d-ronnqvist
added a commit
to d-ronnqvist/swift-docc
that referenced
this pull request
Apr 27, 2023
…ang#565) * Use link resolution to match documentation extensions with symbols Also, fix incorrect source url in technology root diagnostic rdar://108392613 * Add test for matching language specific documentation extension links * Allow documentation extension links to resolve relative to the module rdar://76252171 * Warn when a documentation extension doesn't match a symbol rdar://108392639 * Expect different behavior in tests when the old link resolver is used * Restore old implementation detail for ConvertService only * Restore test assertion about documentation extension in asset store
d-ronnqvist
added a commit
that referenced
this pull request
Apr 27, 2023
…569) * Use link resolution to match documentation extensions with symbols Also, fix incorrect source url in technology root diagnostic rdar://108392613 * Add test for matching language specific documentation extension links * Allow documentation extension links to resolve relative to the module rdar://76252171 * Warn when a documentation extension doesn't match a symbol rdar://108392639 * Expect different behavior in tests when the old link resolver is used * Restore old implementation detail for ConvertService only * Restore test assertion about documentation extension in asset store
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:
Summary
This uses the link resolver to match documentation extensions with symbols. This allows for using link resolution features in documentation extension title links. For example:
Dependencies
None
Testing
In a Swift package with a documentation catalog;
Add code where two symbols have the same case insensitive name:
Add a documentation extension file and link to one of the symbols without prefixing with the module and without disambiguation:
The content of this documentation extension file should be included on the documentation page for the
Inner
enumeration.Add another documentation extension file and link to a symbol that doesn't exist in the module:
There should be a warning saying that the module doesn't contain a "ThisDoesNotExist" symbol.
Add another documentation extension file and link to first symbol but make the symbol link more spelled out:
There should be a warning saying that multiple documentation extension files match the
Inner
enumeration.Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/test
script and it succeeded