Fix @SupportedLanguage directive for articles
#1318
Merged
+156
−15
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
snprajwal
force-pushed
the
pnadig/article-supported-lang
branch
from
a7af0ff to
77cc7c5
Compare
|
@swift-ci please test |
d-ronnqvist
reviewed
Oct 10, 2025
snprajwal
force-pushed
the
pnadig/article-supported-lang
branch
from
77cc7c5 to
d9e38ad
Compare
|
@swift-ci please test |
d-ronnqvist
reviewed
Oct 15, 2025
d-ronnqvist
approved these changes
Oct 15, 2025
The `@SupportedLanguage` directive allows specifying a language that an article is available in. It can be used within the `@Metadata` directive like in the below example, where the article is made available in both Swift and Objective-C: ``` @metadata { @SupportedLanguage(swift) @SupportedLanguage(objc) } ``` This directive is processed when creating the topic graph node for the article. The supported languages of an article need to be stored in the resolved topic reference that eventually gets serialised into the render node, which the navigator uses. When a catalog contains more than one module, any articles present are not registered in the documentation cache, since it is not possible to determine what module it is belongs to. In such cases, to correctly include the set of supported languages, they must be added to the reference in the topic graph node during creation, rather than creating the reference and later updating this information during registration. This patch adds the logic to store the set of supported languages during topic node creation for all articles, indepedent of the cache registration. rdar://160284853
snprajwal
force-pushed
the
pnadig/article-supported-lang
branch
from
d9e38ad to
dba85cd
Compare
|
@swift-ci please test |
d-ronnqvist
reviewed
Oct 15, 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://160284853
Summary
The
@SupportedLanguagedirective allows specifying a language that anarticle is available in. It can be used within the
@Metadatadirectivelike in the below example, where the article is made available in both
Swift and Objective-C:
This directive is processed when creating the topic graph node for the
article. The supported languages of an article need to be stored in the
resolved topic reference that eventually gets serialised into the render
node, which the navigator uses. When a catalog contains more than one
module, any articles present are not registered in the documentation
cache, since it is not possible to determine what module it is belongs
to. In such cases, to correctly include the set of supported languages,
they must be added to the reference in the topic graph node during
creation, rather than creating the reference and later updating this
information during registration. This patch adds the logic to store the
set of supported languages during topic node creation for all articles,
indepedent of the cache registration.
Dependencies
N/A
Testing
Unit tests have been added to test this functionality when creating the documentation node and reference for articles containing the directive.
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded