[5.7] Do not emit variants for pages in article-only catalogs #248
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
franklinsch
commented
May 10, 2022
franklinsch
commented
- Rationale: Do not emit language variants information for article-only catalogs, so that renderers don't advertise these as being available in "Swift", which not accurate.
- Risk: Low
- Risk Detail: This is a targeted change that only apply when building article-only catalogs.
- Reward: Medium
- Reward Details: This only applies to article-only catalogs.
- Original PR: Do not emit variants for pages in article-only catalogs #241
- Issue: rdar://92758192
- Code Reviewed By: @ethan-kusters
- Testing Details: Added an automated test to cover the new behavior.
Refactor TestRenderNodeOutputConsumer into its own file so that it can be used in other tests.
For article-only catalogs, i.e., catalogs that use @TechnologyRoot, don't emit the variants array in the render node, so that renderers don't display the page's language, since it doesn't have a language. A longer-term fix here would be to not consider articles in article-only catalogs to be "Swift", and implement logic in RenderNodeTranslator to not emit variants information for language-less pages (github.com/swiftlang/issues/240). rdar://92758192
franklinsch
force-pushed
the
article-only-language-variants-5.7
branch
from
3888cfa to
01644e0
Compare
|
@swift-ci please test |
ethan-kusters
approved these changes
May 11, 2022
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.