DOC: update copy keyword explanation in astype docstring #63274
Merged
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
| 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 |
Member
Author
There was a problem hiding this comment.
Since no one should specify this keyword, we could also just leave out the type part entirely?
Suggested change
| copy : bool, default False | |
| copy |
(probably would need to suppress some numpydoc linting rule for this method, though)
Member
There was a problem hiding this comment.
In general for a deprecated parameter, I think we should still keep the type/default/description even if we don't want users to use it. In this case I would update the description to something like
This keyword is now ignored; changing its value will have no impact on the method.
Member
|
Thanks @jorisvandenbossche |
Member
Author
|
Looks good: https://pandas.pydata.org/docs/dev/reference/api/pandas.DataFrame.astype.html Will do the same for the other methods with copy keywords. |
Member
Author
|
-> #63297 |
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.
xref #63144
I just removed the explanation of the keyword entirely (since the keyword is ignored and has no effect anymore), just leaving the deprecation note (and updated that to reflect this is now in effect)