DOC: Add comment about inplace/copy proposal #51487
Conversation
doc/source/whatsnew/v2.0.0.rst
Outdated
| @@ -1423,6 +1423,15 @@ Metadata | |||
|
|
|||
| Other | |||
| ^^^^^ | |||
|
|
|||
| .. note:: | |||
There was a problem hiding this comment.
This seems to be a bit strange location to put it? (inside a "Bugs" subsection)
There was a problem hiding this comment.
Yeah good point, but did not want to put it right at the top, so not really sure where to place it
There was a problem hiding this comment.
We could put it under other api changes?
|
|
||
| .. code-block:: python | ||
|
|
||
| df.replace(5, inplace=True) |
There was a problem hiding this comment.
I don't think replace is a good example. We are keeping inplace there.
There was a problem hiding this comment.
That’s why I am using it. I could add an explicit comment that replace is one of the few methods where we are keeping it
There was a problem hiding this comment.
Added a small note that replace might keep inplace
There was a problem hiding this comment.
Thanks, it might be good to also give an example of something that would lose inplace, for comparison's sake.
There was a problem hiding this comment.
What would you want to show with it? I am struggling to come up with an explanation for such an example
There was a problem hiding this comment.
I don't think we would need to go to in detail, just say e.g.
"Some methods cannot operate inplace (e.g. reindex), or would already avoid copying the data with Copy on Write. (e.g. rename)
It is recommended that the inplace/copy parameters be avoided for those methods".
No big deal if we don't add this, though, since people can always read the PDEP.
There was a problem hiding this comment.
Ah got you, I thought you wanted to add a code example.
There was a problem hiding this comment.
I'll leave the suggestion to not use them out. When used in the appropriate context it can speed up your code. I think it's clear enough that users can figure the consequences out for themself.
|
Thx, let’s merge then we‘ll get it into the rc |
doc/source/whatsnew/vX.X.X.rstfile if fixing a bug or adding a new feature.