-
Notifications
You must be signed in to change notification settings - Fork 1
Description
Overview
This issue tracks follow-up improvements for the Python documentation section that were identified during the review of PR #403.
Related PR: #403
Requested by: @amotl
Backlog Items
1. Add Runnable Examples to Python Clients
Context: PR #403 comment
Provide runnable examples for each Python client by either:
- Adding inline dependencies using PEP 723 (implemented by
uv) - Adding simple
pip install ...incantations to the docs, followed by invocation instructions
This approach has been conducted for other clients, so the Python area should not be left behind.
Affected files:
docs/connect/python/crate-python.mdand similar client documentation pages
2. Expand DataFrame Libraries Documentation
Context: PR #403 comment
Tasks:
- Expand DataFrame libraries (Dask, pandas, Polars) into individual dedicated pages
- Absorb content from the "integrations" section
- Absorb content from SQLAlchemy dialect's DataFrame operations documentation:
Affected files:
docs/connect/python/index.md- Create new pages for each DataFrame library
3. Review and Incorporate Content from GH-138
Context: PR #403 comment
Review content from the patch in issue #138 before finalizing the Python documentation section.
Reference: #138
4. Improve Python Presentation Inspired by DuckDB
Context: PR #403 comment
DuckDB provides an excellent example of how to organize driver documentation across different domains and connectivity options:
Consider improving our Python presentation using similar organizational patterns.
Affected files:
docs/connect/python/index.mdand related structure
Notes
These items were deferred from PR #403 to keep the initial refactoring focused. They represent enhancements and additional content that will further improve the Python documentation section.