Add DataFrame API Documentation for DataFusion Python #1132
Conversation
This file contains hidden or 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
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?
Rationale for this change
This PR introduces comprehensive documentation for the
DataFrameAPI in the DataFusion Python library. It enhances the usability and discoverability of the DataFrame functionalities, providing developers with structured, example-rich content on how to create, manipulate, and render DataFrames using DataFusion.What changes are included in this PR?
dataframe.rstcontaining:api/index.rstas a new section in the documentation to include the DataFrame API referenceindex.rstto link to the new API documentation sectionAre these changes tested?
Since this is a documentation-only PR, traditional unit tests do not apply. The added examples can be used interactively to verify correctness.
Are there any user-facing changes?
Yes. This PR introduces a new "DataFrame API" documentation section that users can navigate to from the main documentation index. It improves the developer experience by offering detailed and formatted guides on using the DataFusion Python API.