You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When associating documentation extension files with symbols, DocC relies on exact resolved reference matches instead of using the link resolver infrastructure to find the symbol.
This means that a link that would be unambiguous in content may not be an accepted documentation extension heading link.
Together with #560 there's a risk that a developer would copy a link that works in the content into a documentation extension file and not notice that the link doesn't work there.
Checklist
If possible, I've reproduced the issue using the main branch of this package.
Description
When associating documentation extension files with symbols, DocC relies on exact resolved reference matches instead of using the link resolver infrastructure to find the symbol.
This means that a link that would be unambiguous in content may not be an accepted documentation extension heading link.
Together with #560 there's a risk that a developer would copy a link that works in the content into a documentation extension file and not notice that the link doesn't work there.
Checklist
main
branch of this package.Expected Behavior
Symbol links in documentation extension headers should have the same capabilities as symbol link in content.
Actual behavior
Symbol links in documentation extension headers need to exactly match the resolved reference and its added disambiguation.
Steps To Reproduce
In a Swift package with a documentation catalog;
# ``MyModule/Outer/Inner`` The content of this file is ignored because the heading link doesn't resolve without disambiguation.
Swift-DocC Version Information
e135c5b
Swift Compiler Version Information
The text was updated successfully, but these errors were encountered: