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

Article reference can collide with top-level symbol #593

Open
2 tasks done
d-ronnqvist opened this issue May 19, 2023 · 1 comment
Open
2 tasks done

Article reference can collide with top-level symbol #593

d-ronnqvist opened this issue May 19, 2023 · 1 comment
Labels
bug Something isn't working

Comments

@d-ronnqvist
Copy link
Contributor

d-ronnqvist commented May 19, 2023

Description

If a catalog is named the same as the module and an article is named the same as a top-level symbol, then the article and the symbol both get the same ResolvedTopicReferences and DocC only emits a page for the article.

rdar://109177620

Checklist

  • If possible, I've reproduced the issue using the main branch of this package.
  • This issue hasn't been addressed in an existing GitHub issue.

Expected Behavior

The ResolvedTopicReferences should contain disambiguation so that nothing every page has a unique reference. Both pages should be emitted.

Actual behavior

Only the article page is emitted.

Steps To Reproduce

  1. Create a DocC catalog with the same name as the module it documents
  2. Create an article—not a documentation extension—and name it the same as one of the top-level symbols in the module
  3. Curate the article
  4. Build documentation and inspect the content of the output. There won't be a json file for the symbol.

Swift-DocC Version Information

At least a few versions back (5.5)

Swift Compiler Version Information

No response

@d-ronnqvist d-ronnqvist added the bug Something isn't working label May 19, 2023
@d-ronnqvist d-ronnqvist changed the title Article reference may collide with top-level Article reference may collide with top-level symbol May 26, 2023
@d-ronnqvist d-ronnqvist changed the title Article reference may collide with top-level symbol Article reference can collide with top-level symbol May 26, 2023
@tayloraswift
Copy link
Member

tayloraswift commented Nov 28, 2023

note this currently affects swift-markdown at 0.3 (BlockMarkup, InlineMarkup)

see: swiftlang/swift-markdown#158

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants