Skip to content

DOC: Add CoW optimizations to whatsnew #51148

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 3, 2023
Merged

Conversation

phofl
Copy link
Member

@phofl phofl commented Feb 3, 2023

  • closes #xxxx (Replace xxxx with the GitHub issue number)
  • Tests added and passed if fixing a bug or adding a new feature
  • All code checks passed.
  • Added type annotations to new arguments/methods/functions.
  • Added an entry in the latest doc/source/whatsnew/vX.X.X.rst file if fixing a bug or adding a new feature.

cc @lithomas1 @jorisvandenbossche

Let's add them on a pr basis after this is merged

@phofl phofl added this to the 2.0 milestone Feb 3, 2023
@phofl phofl added the Docs label Feb 3, 2023
@mroeschke mroeschke merged commit 6ccde9d into pandas-dev:main Feb 3, 2023
@mroeschke
Copy link
Member

Thanks @phofl

@phofl phofl deleted the doc_cow branch February 3, 2023 21:00
@jorisvandenbossche
Copy link
Member

FWIW, while this list is getting long (and basically becoming just a list of all pandas methods ;)), I am not sure how useful it is to explicitly list them (it makes this item in the whatsnew section quite long and potentially distracting from the more important content).

It might be nice if we could just say "A new lazy copy mechanism that defers the copy until the object in question is modified was added to all relevant methods." ?
(if that would actually be the case ..)

@phofl
Copy link
Member Author

phofl commented Feb 8, 2023

Generally, I agree. But as long as we don't have everything we should reference all methods that already have the optimization somewhere.

Linking to our issue might be confusing, since we will update this after we released 2.0. But open for suggestions, as long as the information is available somewhere

@phofl
Copy link
Member Author

phofl commented Feb 8, 2023

We could add a user guide section (wanted to do this anyway before the final 2.0 release is out) and have all optimised methods there

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants