DOC: update description for deprecated copy keyword in docstrings (CoW is now in effect) #63297
+209
−288
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
…W is not in effect)
Member
Author
|
Assuming that at some point this deprecation note gets removed once that is enforced, I am wondering if we should not have a standard phrase that we could include in all those docstrings (in the return type description? or in the notes?) about the object being returned: that it is a new object but with lazy/deferred copy under CoW. Of course that is now the general rule for every method that might not have to copy all the data. |
Member
I'd be good with a centralized place in the user guide, but I'm of the opinion this need not be mentioned in the docstring. |
Member
|
Thanks @jorisvandenbossche |
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.
Follow-up on #63274, doing the same change to the other methods that have a deprecated
copykeyword