Skip to content

DOC: Correct typing of 'copy' argument in astype docstring (#63144) #63149

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.

Sign up for GitHub

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
wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −4
Open

DOC: Correct typing of 'copy' argument in astype docstring (#63144) #63149

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions pandas/core/generic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6340,10 +6340,12 @@ def astype(
mapping, e.g. {col: dtype, ...}, where col is a column label and dtype is
a numpy.dtype or Python type to cast one or more of the DataFrame's
columns to column-specific types.
copy : bool, default False
Return a copy when ``copy=True`` (be very careful setting
``copy=False`` as changes to values then may propagate to other
pandas objects).
copy : bool or None, default None
Whether to copy the data or not.
- True : always return a new object.
- False : try to avoid copying and return a view if possible.
Copy link
Member

@rhshadrach rhshadrach Nov 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With copy-on-write now the default, this seems misleading to me.

- None : use the default lazy-copy behavior (recommended).
Copy link
Member

@rhshadrach rhshadrach Nov 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The type-hint is for no_default, not None. Also the wording here suggests to me that not specifying None does not use the default lazy-copy behavior.

.. note::
The `copy` keyword will change behavior in pandas 3.0.
Expand Down
Loading