Skip to content

Conversation

@dylansturg
Copy link

@dylansturg dylansturg commented Dec 15, 2025

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:

  1. Provide setup instructions.
  2. Explain in detail how the functionality can be tested.

Checklist

Make sure you check off the following items. If they cannot be completed, provide a reason.

  • Added tests
  • Ran the ./bin/test script and it succeeded
  • Updated documentation if necessary

…ile's name.

This is a companion to change XYZ.
…ibute.

Existing tests still pass as-is because symbol graphs without the `extended` attribute use the existing behavior, to read the extended module from the file name.
@dylansturg dylansturg force-pushed the symbolkit-extended-module branch from 31e7ea9 to 8777ba0 Compare December 16, 2025 21:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant