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

ConvertService relies on documentation extension files being considered "resolved" even when build has no symbols #567

Open
2 tasks done
d-ronnqvist opened this issue Apr 26, 2023 · 0 comments
Labels
bug Something isn't working

Comments

@d-ronnqvist
Copy link
Contributor

Description

The ConvertService relies on an old implementation detail where every documentation extension file was always “resolved” even when it didn’t match a symbol or when the build had no symbol graph files.

This behavior is different from how documentation extension files work in regular builds. Some consequences of this are:

  • the process that interacts with the convert service can't distinguish between documentation extension files that match symbols and documentation extension files that don't match symbols.
  • the process that interacts with the convert service is responsible for maintaining it's own link resolutions implementation to match the behavior of a regular build.
  • the process that interacts with the convert service is responsible for diagnosing documentation extension files that don't matching symbols and for matching the diagnostics that would be in a regular build.

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

No response

Actual behavior

No response

Steps To Reproduce

No response

Swift-DocC Version Information

No response

Swift Compiler Version Information

No response

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

1 participant