Skip to content

Add a dataframe.rst for #1100 #1101

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kosiew opened this issue Apr 8, 2025 · 0 comments · May be fixed by #1132
Open

Add a dataframe.rst for #1100 #1101

kosiew opened this issue Apr 8, 2025 · 0 comments · May be fixed by #1132
Labels
enhancement New feature or request

Comments

@kosiew
Copy link
Contributor

kosiew commented Apr 8, 2025

Is your feature request related to a problem or challenge? Please describe what you are trying to do.

I'm trying to document the newly added HTML formatting features for DataFusion DataFrames in Python (introduced in #1100). Currently, there's no dedicated documentation page (e.g., dataframe.rst) that outlines the DataFrame API, usage examples, or details about how HTML rendering works in Jupyter environments. This makes it harder for users to discover and leverage these features.

Describe the solution you'd like

Add a dataframe.rst file to the Python API documentation that includes:

  • An overview of the DataFrame API
  • Explanation and usage examples for _repr_html_ rendering
  • How to configure HTML rendering using configure_formatter()
  • Examples of using custom style providers and formatters
  • How to reset or globally manage formatting styles

Describe alternatives you've considered

  • Embedding limited information in existing pages like index.rst or session.rst, but this would not provide a clean or discoverable structure.
  • Relying solely on docstrings or tests, which is not user-friendly for new users.

Additional context

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant