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

Don't suggest bundle name as possible replacement for symbol links #900

Merged

Conversation

d-ronnqvist
Copy link
Contributor

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

Summary

This fixes a confusing diagnostic solution when a misspelled link matches the also misspelled bundle name (specified in an Info.plist)

Dependencies

None

Testing

In a any project with some module documentation:

  • Add a documentation catalog with an Info.plist file that specifies a misspelled version of the module name for "CFBundleDisplayName".
  • In any content, for example a documentation comment or an article, write a symbol link using the misspelled version of the module name.
  • Build documentation for the project.
    • The diagnostic about the unresolved link should only suggest to replace the misspelled name with the correctly spelled module name.

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~ Not applicable

@d-ronnqvist
Copy link
Contributor Author

@swift-ci please test

Copy link
Member

@sofiaromorales sofiaromorales left a comment

Choose a reason for hiding this comment

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

👍

@d-ronnqvist d-ronnqvist merged commit 49c6d92 into apple:main Apr 26, 2024
2 checks passed
@d-ronnqvist d-ronnqvist deleted the no-symbol-link-suggestion-for-bundle-name branch April 26, 2024 13:45
d-ronnqvist added a commit to d-ronnqvist/swift-docc that referenced this pull request Apr 26, 2024
emilyychenn pushed a commit to emilyychenn/swift-docc that referenced this pull request Apr 30, 2024
d-ronnqvist added a commit that referenced this pull request May 3, 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.

None yet

2 participants