Emit variants if any root module is a symbol kind #1333
Merged
Conversation
This file contains hidden or 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
Contributor
Author
|
@swift-ci please test |
d-ronnqvist
reviewed
Nov 6, 2025
One of the test methods in `RenderNodeTranslatorTests` was duplicated multiple times. It has been extracted out of the tests and deduplicated.
When the render node translator visits articles, it emits variants for each language that the article is supported in. This step is skipped if an article-only catalog is being built, since it would otherwise lead to a redundant "Swift" language marker being rendered in the page. However, if a catalog contains more than one module, i.e. an article-only collection and a different module's symbol graph in the same catalog, then the variants are not emitted despite the possibility of the page being available in more than one language. This commit changes the boolean check to skip emitting variants only if all root modules are article-only. It does not affect the behaviour when building a correctly configured catalog that contains a sole root module. rdar://163926698
snprajwal
force-pushed
the
pnadig/source-langs
branch
from
e49e5c2 to
7f1ab5f
Compare
Contributor
Author
|
@swift-ci please test |
snprajwal
changed the title
snprajwal
changed the title
d-ronnqvist
approved these changes
Nov 6, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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://163926698
Summary
When the render node translator visits articles, it emits variants for each language that the article is supported in. This step is skipped if an article-only catalog is being built, since it would otherwise lead to a redundant "Swift" language marker being rendered in the page. However, if a catalog contains more than one module, i.e. an article-only module and a different module's symbol graph in the same catalog, then the variants are not emitted despite the possibility of the page being available in more than one language. This commit changes the boolean check to skip emitting variants only if all roots modules are article-only. It does not affect the behaviour when building a correctly configured catalog that contains a sole root module.
Dependencies
N/A
Testing
A new test has been added to verify this behaviour. A nested helper function that was duplicated multiple times has been extracted into a standalone function that can be reused across tests. The tests have been refactored accordingly to use this function instead.
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded