Only curate external non-symbols in different lang #1269
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
snprajwal
force-pushed
the
pnadig/fix-nav
branch
2 times, most recently
from
6c5b795 to
812c56a
Compare
|
@swift-ci please test |
d-ronnqvist
requested changes
Aug 5, 2025
snprajwal
force-pushed
the
pnadig/fix-nav
branch
from
812c56a to
2c1a2b6
Compare
snprajwal
changed the title
snprajwal
force-pushed
the
pnadig/fix-nav
branch
from
2c1a2b6 to
dc0f2e2
Compare
|
@swift-ci please test |
anferbui
reviewed
Sep 12, 2025
d-ronnqvist
requested changes
Sep 15, 2025
snprajwal
force-pushed
the
pnadig/fix-nav
branch
from
dc0f2e2 to
eef3d1e
Compare
snprajwal
changed the title
snprajwal
force-pushed
the
pnadig/fix-nav
branch
from
eef3d1e to
d9b9206
Compare
|
@swift-ci please test |
d-ronnqvist
reviewed
Sep 30, 2025
snprajwal
force-pushed
the
pnadig/fix-nav
branch
from
d9b9206 to
0b61e5f
Compare
|
I've added a note with the link to #240 in the relevant comments, and also left FIXMEs for us to come back to. |
|
@swift-ci please test |
PR swiftlang#757 enabled DocC to include manually curated non-symbol nodes in the topics section, irrespective of the node language. This allows curating articles across documentation in different languages, even though the article's language is considered to be "Swift". However, the logic was too permissive, and allowed curating non-symbol nodes within the same bundle but across different languages. This is incorrect, since the target page should be annotated with the `SupportedLanguage` directive to enable curating it in a different language. A bespoke mechanism to curate an internal reference correctly is not necessary. This patch tightens the logic to only allow curating external references in a different language than the source page language, and removes the existing test for the undesired behaviour of including local references to cross-language symbols. The changes in PR swiftlang#757 were not propagated to the navigator, resulting in the references being present in the topics section but not in the sidebar. This patch also introduces the curation logic in the navigator to maintain parity with the topics section. The navigator tests for external render nodes have been modified accordingly to reflect this change. rdar://155522179
snprajwal
force-pushed
the
pnadig/fix-nav
branch
from
0b61e5f to
97924a3
Compare
d-ronnqvist
approved these changes
Oct 6, 2025
|
@swift-ci please test |
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.
Bug/issue #, if applicable: rdar://155522179
Summary
PR #757 enabled DocC to include manually curated non-symbol nodes in the
topics section, irrespective of the node language. This allows curating
articles across documentation in different languages, even though the
article's language is considered to be "Swift". However, the logic was
too permissive, and allowed curating non-symbol nodes within the same
bundle but across different languages. This is incorrect, since the
target page should be annotated with the
SupportedLanguagedirectiveto enable curating it in a different language. A bespoke mechanism to
curate an internal reference correctly is not necessary. This patch
tightens the logic to only allow curating external references in a
different language than the source page language, , and removes the
existing test for the undesired behaviour of including local references
to cross-language symbols.
The changes in PR #757 were not propagated to the navigator, resulting
in the references being present in the topics section but not in the
sidebar. This patch also introduces the curation logic in the navigator
to maintain parity with the topics section. The navigator tests for
external render nodes have been modified accordingly to reflect this
change.
Dependencies
None
Testing
The navigator tests in
ExternalRenderNodeTestshave been updated to reflect the curation behaviour.Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded