kosiew opened a new pull request, #1132:
URL: https://github.com/apache/datafusion-python/pull/1132
## Which issue does this PR close?
- Closes #1101.
## Rationale for this change
This PR introduces comprehensive documentation for the `DataFrame` API 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?
- Added `dataframe.rst` containing:
- Overview of the DataFrame abstraction
- Examples of DataFrame creation from various sources
- Common operations (select, filter, aggregate, join, etc.)
- Terminal operations and output formats
- HTML rendering features in Jupyter with customization options
- Advanced formatting examples and best practices
- Added `api/index.rst` as a new section in the documentation to include the
DataFrame API reference
- Updated the root `index.rst` to link to the new API documentation section
## Are 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.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
