Skip to content
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

Revert support for module-relative documentation extension links #574

Conversation

d-ronnqvist
Copy link
Contributor

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

Summary

This reverts the support for resolving documentation extensions links relative to modules since it caused a regression when a module and a top-level symbol had the same name.

Dependencies

None.

Testing

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
Copy link
Contributor Author

@swift-ci please test

@ethan-kusters
Copy link
Contributor

Should we do a true revert here to be safe? Or are you confident the more isolated change will still fix any issues?

@d-ronnqvist
Copy link
Contributor Author

Should we do a true revert here to be safe? Or are you confident the more isolated change will still fix any issues?

I'm pretty confident in that this fixes the issue. The regression is specific to modules that have a top-level symbol with the same name. I have a project that reproduced the regression that works after these changes.

If possible I would like to avoid reverting the entire merge since the same PR also fixed #561 and #560.

@ethan-kusters
Copy link
Contributor

If possible I would like to avoid reverting the entire merge since the same PR also fixed #561 and #560.

That makes sense – I didn't realize we were still getting the other benefits. Thank you!

@d-ronnqvist d-ronnqvist merged commit ea45032 into swiftlang:main Apr 28, 2023
@d-ronnqvist d-ronnqvist deleted the revert-module-relative-documentation-extension-links branch April 28, 2023 23:53
d-ronnqvist added a commit to d-ronnqvist/swift-docc that referenced this pull request Apr 28, 2023
d-ronnqvist added a commit that referenced this pull request Apr 29, 2023
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.

3 participants