Skip to content

DOC: remove inplace usage from docstring examples #51124

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 6 commits into from
Feb 3, 2023

Conversation

phofl
Copy link
Member

@phofl phofl commented Feb 2, 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.

Removes the inplace=True usage examples from the docstring examples.

@phofl phofl added the Docs label Feb 2, 2023
@phofl phofl added this to the 2.0 milestone Feb 2, 2023
Copy link
Member

@MarcoGorelli MarcoGorelli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me pending green

@phofl
Copy link
Member Author

phofl commented Feb 2, 2023

Removed 2 additional examples advertising copy=False

@MarcoGorelli
Copy link
Member

is using copy discouraged as well? I may have missed that

if so, no objections, lgtm

@phofl
Copy link
Member Author

phofl commented Feb 3, 2023

copy=False will be the new default with CoW. copy=True can be done through df.func().copy(), so we will propose removing the copy argument as well in PDEP7. Copy won't have any use in the future, so should remove the reference I guess.

@MarcoGorelli
Copy link
Member

makes sense, thanks! anything else you wanted to get in here or good to merge?

@phofl
Copy link
Member Author

phofl commented Feb 3, 2023

Nothing I can think of right now, so good to go I think

@MarcoGorelli
Copy link
Member

let's ship it, thanks @phofl !

@MarcoGorelli MarcoGorelli merged commit 5645847 into pandas-dev:main Feb 3, 2023
@phofl phofl deleted the inplace_docstring branch February 3, 2023 16:35
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.

2 participants