Improve DataFrame docs flow#1526
Open
vandit98 wants to merge 1 commit intoapache:mainfrom
Open
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.
Closes #1397.
Rationale for this change
The DataFrame guide currently mixes the main user flow with lower-level Arrow streaming details, display behavior, and metrics guidance. This makes the page harder to scan for new users who are trying to understand the basic DataFrame lifecycle.
What changes are included in this PR?
__arrow_c_stream__content into a dedicatedarrow-interfacepage under the DataFrame section.Are there any user-facing changes?
Yes, documentation-only changes. The DataFrame docs should be easier to scan and the Arrow streaming content now has a dedicated page.
Verification performed by Vandit:
git diff --checkdocs/source/user-guide/dataframe/index.rstlinksarrow-interfaceand thatdocs/source/user-guide/dataframe/arrow-interface.rstexists with the expected headingdocs/source/index.rstIPython example because the compileddatafusionpackage was not installed in that temp venv (ModuleNotFoundError: No module named 'datafusion').