DOC: Add note for copy keywords for Copy-on-Write #56033
Conversation
| @@ -6428,6 +6428,15 @@ def astype( | |||
| Return a copy when ``copy=True`` (be very careful setting | |||
| ``copy=False`` as changes to values then may propagate to other | |||
| pandas objects). | |||
|
|
|||
| .. note:: | |||
There was a problem hiding this comment.
Can you make this warning a shared docstring?
There was a problem hiding this comment.
Personally I find shared docstrings quite annoying (and untransparant, difficult to understand), so while it's nice to deduplicate and only have 1 place to update this note, I am also fine with simply copy-pasting this note multiple times once we have finalized its wording.
(certainly for methods that right now don't yet make use of shared docstrings)
There was a problem hiding this comment.
Yeah I don't like them either
There was a problem hiding this comment.
Looks good to me.
I might want to say something like: "in the future this will no longer copy by default, so you don't need to specify this keyword", but the problem is in being both succinct and accurate, because of course that isn't fully true, we will copy later on. Which is what your "lazy copy" covers, but then I don't know how many people will fully understand that.
Do we want to also make use of this note to mention "you can already get that future behaviour by enabling CoW, see ...` ?
Co-authored-by: Joris Van den Bossche <[email protected]>
Co-authored-by: Joris Van den Bossche <[email protected]>
Co-authored-by: Joris Van den Bossche <[email protected]>
|
I've added the enable cow already (big fan of this) and added a defers the copy to the lazy copy mechanism (we also link to the cow docs where this is explained in more detail) |
|
going ahead with the others now |
doc/source/whatsnew/vX.X.X.rstfile if fixing a bug or adding a new feature.Starting with one method to figure out wording. Will add for the remaining ones after this one