Read the extended module's name from the SymbolGraph. #107
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.
This is a companion to a Swift compiler change to write the extended module name in the SymbolGraph.
Summary
Today the Swift documentation pipeline cannot generate documentation for modules with relatively long names, due to including 2 module names in the symbolgraph file's name. More details in swiftlang/swift#83723.
After the changes in swiftlang/swift#83782, the compiler can output the symbolgraph data but swift-docc and swift-docc-symbolkit cannot use the symbolgraph files with shortened names. This pair of changes aims to enable using the documentatio pipeline for modules with long names.
swiftlang/swift-docc#1399
Dependencies
swiftlang/swift#86057
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