DOC: Correct typing of 'copy' argument in astype docstring (#63144) #63149
+6
−4
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
rhshadrach
requested changes
Nov 19, 2025
Member
rhshadrach
left a comment
There was a problem hiding this comment.
Thanks for the PR! I believe the option of no_default is just to allow the deprecation. I do not think there are any issues with the docs.
| Whether to copy the data or not. | ||
| - True : always return a new object. | ||
| - False : try to avoid copying and return a view if possible. |
Member
There was a problem hiding this comment.
With copy-on-write now the default, this seems misleading to me.
| - True : always return a new object. | ||
| - False : try to avoid copying and return a view if possible. | ||
| - None : use the default lazy-copy behavior (recommended). |
Member
There was a problem hiding this comment.
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.
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.
This PR fixes the documentation mismatch reported in issue #63144
The actual function signature accepts
Noneas a valid value (copy: bool | lib.NoDefault) and the internal implementation supportsNoneto indicate default lazy-copy behavior.This PR updates the docstring to:
No code changes are made, only documentation updates.
astypefor thecopyargument #63144