DOC: Clarify DataFrameXchg parameter is deprecated in from_dataframe #63118
+11
−2
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
The from_dataframe function documentation referenced DataFrameXchg type hint which is deprecated. Updated docstrings to use DataFrame and added deprecation notices to clarify that DataFrameXchg type hint is deprecated since pandas 3.0. Fixes pandas-dev#63111
rhshadrach
requested changes
Nov 16, 2025
| Parameters | ||
| ---------- | ||
| df : DataFrameXchg | ||
| df : DataFrame |
Member
There was a problem hiding this comment.
What is DataFrame intended to mean here? Throughout the docs, it means a pandas DataFrame, which isn't appropriate here since the purpose of this function is to convert other DataFrames.
I'd also be fine just documenting this function as deprecated and leaving it as-is until removal.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
The from_dataframe function documentation referenced DataFrameXchg type hint which is deprecated. Updated docstrings to use DataFrame and added deprecation notices to clarify that DataFrameXchg type hint is deprecated since pandas 3.0.
Fixes #63111
doc/source/whatsnew/vX.X.X.rstfile if fixing a bug or adding a new feature.AGENTS.md.