DOC: Start migration guide for Copy-on-Write #56298
Conversation
| The following sections will explain what this means and how it impacts existing | ||
| applications. | ||
|
|
||
| Migrating to Copy-on-Write | ||
| -------------------------- |
There was a problem hiding this comment.
I wonder if we should move the migration guide further in the file, as right now this section assumes somewhat knowledge about what CoW is, but that is only explained "Description" section that now comes afterwards
There was a problem hiding this comment.
I had similar thoughts, but I wanted to put it as prominent as possible
| Creating a copy of this array allows modification. You can also make the array | ||
| writeable again if you don't care about the pandas object anymore. | ||
|
|
||
| **Only one pandas object is updated at once** |
There was a problem hiding this comment.
The code example you use is already a practical example of it, but I wonder if we should explicitly call out "modifying a column as a Series no longer works"? As I think this will be one of the main use cases where right now the user intended the propagation of the modification (while with dataframe row slices, I think that is much less the case)
| See the section about :ref:`read-only NumPy arrays <copy_on_write_read_only_na>` | ||
| for more details. |
There was a problem hiding this comment.
This "see also" probably belongs in the section above "Accessing the underlying array of a pandas object will return a read-only view"
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]>
Co-authored-by: Joris Van den Bossche <[email protected]>
Co-authored-by: Joris Van den Bossche <[email protected]>
|
I think we should link from the FutureWarning to this section as well, but that can be a follow up |
Co-authored-by: Joris Van den Bossche <[email protected]>
doc/source/whatsnew/vX.X.X.rstfile if fixing a bug or adding a new feature.