Minor: improve CatalogProvider documentation with rationale and info about remote catalogs #8968
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
comphead
reviewed
Jan 23, 2024
| /// Represent a list of named [`CatalogProvider`]s. | ||
| /// | ||
| /// Please see the documentation on `CatalogProvider` for details of | ||
| /// implementing a custom catalog. | ||
| pub trait CatalogList: Sync + Send { |
There was a problem hiding this comment.
perhaps CatalogProviderList will be a better name? I can do this in following PR
comphead
approved these changes
Jan 23, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which issue does this PR close?
related to #7013
Rationale for this change
The topic about how to implement remote catalogs has come up several times (most recently in #8887) so it would be good to update the docs to provide more detail
What changes are included in this PR?
CatalogProvider]Are these changes tested?
covered by CI tests
Are there any user-facing changes?
Better docs