Enhance Documentation for Dataset Previews #2074
Merged
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
Signed-off-by: Sajid Alam <[email protected]>
1 task
| @@ -11,7 +11,14 @@ PlotlyPreview = NewType("PlotlyPreview", dict) | |||
| JSONPreview = NewType("JSONPreview", dict) | |||
| ``` | |||
|
|
|||
| Arbitrary arguments can be included in the `preview()` function, which can be later specified in the `catalog.yml` file. | |||
| ## TablePreview | |||
There was a problem hiding this comment.
I think we could do it for every Preview we have
astrojuanlu
reviewed
Sep 3, 2024
astrojuanlu
approved these changes
Sep 3, 2024
Signed-off-by: Sajid Alam <[email protected]>
rashidakanchwala
approved these changes
Sep 9, 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.
Description
Related to: #1884 and #1847
Update the documentation for dataset preview functionality. It clarifies the expected return type and data structure for
TablePreview.Development notes
Expanded the documentation to provide clear guidance on the required data format for
TablePreview.Checklist
RELEASE.mdfile