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

Add simplified implementation of documentation input discovery #1038

Merged
merged 4 commits into from
Oct 8, 2024

Conversation

d-ronnqvist
Copy link
Contributor

@d-ronnqvist d-ronnqvist commented Sep 24, 2024

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

Summary

This is the second of many changes to redefine how documentation contexts are created.

This change specifically renames "documentation bundle" to "documentation inputs" and creates a new type that discovers documentation catalogs and creates documentation inputs. This is the same as LocalFileSystemDataProvider and GeneratedDataProvider except that it doesn't conform to DocumentationWorkspaceDataProvider (or any other protocol for that matter).

This new code is't used anywhere (except in the tests that verify that it behaves the same as the previous code). It's going to be a large change to switch over to this implementation, so I've deferred that to a follow up PR because people have been saying that they prefer multiple smaller PRs over one larger PR. For the same reason, this PR doesn't deprecate the old "documentation bundle" name or update existing code that references it.

Dependencies

This builds on top of the changes from #1031.

The specific changes in this PR can be seen in this diff

Testing

Nothing in particular. This is not user-facing change.

Checklist

Make sure you check off the following items. If they cannot be completed, provide a reason.

  • Added Update tests
  • Ran the ./bin/test script and it succeeded
  • Updated documentation if necessary

@d-ronnqvist d-ronnqvist changed the title Extract Input discovery Add simplified implementation of documentation input discovery Sep 24, 2024
@d-ronnqvist d-ronnqvist added the code cleanup Code cleanup *without* user facing changes label Sep 24, 2024
@d-ronnqvist
Copy link
Contributor Author

I talked to some people about this offline and we agreed that it would be better to split the bundle renaming into a separate PR.

@d-ronnqvist
Copy link
Contributor Author

@swift-ci please test

@d-ronnqvist d-ronnqvist merged commit 37df0ee into swiftlang:main Oct 8, 2024
2 checks passed
@d-ronnqvist d-ronnqvist deleted the input-discovery branch October 8, 2024 08:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code cleanup Code cleanup *without* user facing changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants