Skip to content

DOC: Remove inplace from user guide #51011

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Feb 2, 2023
Merged

DOC: Remove inplace from user guide #51011

merged 4 commits into from
Feb 2, 2023

Conversation

phofl
Copy link
Member

@phofl phofl commented Jan 27, 2023

This starts with removing inplace from the user guide

@phofl phofl added the Docs label Jan 27, 2023
@noatamir
Copy link
Member

Just a thought: do we want to add any note/guidance somewhere for folks who might be looking specifically for inplace?

@noatamir
Copy link
Member

noatamir commented Jan 27, 2023 •
edited
Loading

Are these errors expected? (in: advanced.rst, local build)
Screenshot of the amended example showing AttributeError

Everything else generated without errors.

@phofl
Copy link
Member Author

phofl commented Jan 27, 2023

Just a thought: do we want to add any note/guidance somewhere for folks who might be looking specifically for inplace?

Was thinking of writing up the PDEP and then linking the discussion in the whatsnew. There could be a better way though

Thx for catching, did not pay enough attention when modifying the examples. Fixed now

@lithomas1
Copy link
Member

Just a thought: do we want to add any note/guidance somewhere for folks who might be looking specifically for inplace?

Was thinking of writing up the PDEP and then linking the discussion in the whatsnew. There could be a better way though

Thx for catching, did not pay enough attention when modifying the examples. Fixed now

@phofl Can you DM me on slack? I was also thinking about writing up a PDEP (didn't get too far though).

lithomas1
lithomas1 reviewed Jan 28, 2023
View reviewed changes
doc/source/getting_started/comparison/includes/copies.rst
@@ -13,11 +13,3 @@ or overwrite the original one:
df = df.sort_values("col1")

.. note::

You will see an ``inplace=True`` keyword argument available for some methods:
Copy link
Member

Choose a reason for hiding this comment

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

Should be fine to keep this one since we're discouraging inplace usage here?

Copy link
Member Author

Choose a reason for hiding this comment

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

But with the wrong arguments, I'd rather add it again after finishing the pdep

@phofl
Copy link
Member Author

phofl commented Feb 1, 2023

Everyone ok with going ahead and merging?

@lithomas1 lithomas1 added this to the 2.0 milestone Feb 2, 2023
@mroeschke mroeschke merged commit 785691e into pandas-dev:main Feb 2, 2023
@mroeschke
Copy link
Member

Thanks @phofl

@phofl phofl deleted the inplace_user_guide branch February 2, 2023 17:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mroeschke mroeschke mroeschke approved these changes

@lithomas1 lithomas1 lithomas1 approved these changes

Assignees
No one assigned
Labels
Docs
Projects
None yet
Milestone
2.0
Development

Successfully merging this pull request may close these issues.
4 participants
@phofl @noatamir @lithomas1 @mroeschke