Skip to content

Support either language representation's relative links in documentation extension files #858

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conversation

d-ronnqvist
Copy link
Contributor

@d-ronnqvist d-ronnqvist commented Mar 15, 2024

Bug/issue #, if applicable: rdar://120380627

Summary

This builds on #854 to allow documentation extension files to use either language representation's relative links when the extension file is associated with a symbol with language refinements.

Dependencies

None

Testing

In a multi-source-language project;
Add a documentation extension file for a container symbol (for example a class or a struct) that have representations in both languages.
Add some relative links to members of this type using either language's spelling of those symbols. Those links should resolve.

When viewing the rendered page, the resolved links should display the language specific spelling of those members, regardless of which spelling was used in the link.

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

@d-ronnqvist d-ronnqvist force-pushed the allow-counterpart-links-in-extension-files branch from 60455fa to 557be05 Compare March 15, 2024 16:16
Copy link
Contributor

@daniel-grumberg daniel-grumberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@d-ronnqvist
Copy link
Contributor Author

@swift-ci please test

@d-ronnqvist d-ronnqvist merged commit 0d8ccb7 into swiftlang:main Mar 28, 2024
@d-ronnqvist d-ronnqvist deleted the allow-counterpart-links-in-extension-files branch March 28, 2024 16:10
d-ronnqvist added a commit to d-ronnqvist/swift-docc that referenced this pull request Mar 28, 2024
d-ronnqvist added a commit that referenced this pull request Apr 4, 2024
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.

2 participants