chore: fix catalog's usage docs error and add docs about CatalogList trait
#7582
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
alamb
approved these changes
Sep 18, 2023
There was a problem hiding this comment.
Thank you @tanruixiang
cc @tshauck (someone is reading the documentation)
alamb
changed the title
CatalogList trait
alamb
changed the title
CatalogList traitCatalogList trait
|
nice -- thanks from me as well @tanruixiang |
that would be most appreciated and valuable @tanruixiang -- it is an area that really could use more improvement and will help future users a lot. THANK YOU 🙏 |
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?
Closes #.
Rationale for this change
The documentation misuses
MemoryCatalogListand missings the introduction ofCatalogList. There are also some markdown structure issues.What changes are included in this PR?
Fix docs's errors and add the
CatalogListtrait content.Are these changes tested?
Are there any user-facing changes?