Skip to content
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

DOC: append deprecation #45587

Merged
merged 10 commits into from
Feb 11, 2022
Merged

DOC: append deprecation #45587

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
e93958a
DOC GH44539
gesoos Jan 24, 2022
d05c5b7
corrected replacement
gesoos Jan 25, 2022
06e03fe
Updated doc string
gesoos Jan 31, 2022
131d0ee
Updated doc string
gesoos Feb 1, 2022
0cec30c
Updated doc string
gesoos Feb 1, 2022
541d5e9
Simplified deprecated in docstring
gesoos Feb 9, 2022
00ba4ee
Merge remote-tracking branch 'upstream/main' into add-deprecated-to-a…
simonjayhawkins Feb 11, 2022
6f4b9fb
add one-liner
simonjayhawkins Feb 11, 2022
26cfee1
flake8 fixup
simonjayhawkins Feb 11, 2022
8e55b93
move above extended summary
simonjayhawkins Feb 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions pandas/core/frame.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8936,6 +8936,10 @@ def append(

Columns in `other` that are not in the caller are added as new columns.

.. deprecated:: 1.4.0
append is deprecated,
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't know if we need 'append is deprecated'. This IS the append doc-string. We don't do this anywhere else.

Also capital the first letter of the sentence.

Copy link
Member

Choose a reason for hiding this comment

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

@jreback isn't it the same as in lookup https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.lookup.html , where it says

DataFrame.lookup is deprecated

?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I took inspiration from existing messages that describe the issue. Since append refers to the method, I would not capitalize it.

Copy link
Contributor

Choose a reason for hiding this comment

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

sure lookup is a full message, this is not.

Copy link
Contributor

Choose a reason for hiding this comment

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

i am ok if its a full sentence in a similar way.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

What about https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.slice_shift.html?

Copy link
Member

Choose a reason for hiding this comment

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

@gesoos I think if you make it similar to how lookup is (suggest to use concat instead, and point to the relevant part of the user guide if there is one - check the whatsnew note) it'll be OK

Copy link
Contributor

Choose a reason for hiding this comment

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

yeah we would like to make these consistent.

use pandas.concat instead.

Parameters
----------
other : DataFrame or Series/dict-like object, or list of these
Expand Down
4 changes: 4 additions & 0 deletions pandas/core/series.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2865,6 +2865,10 @@ def append(
"""
Concatenate two or more Series.

.. deprecated:: 1.4.0
append is deprecated,
use pandas.concat instead.

Parameters
----------
to_append : Series or list/tuple of Series
Expand Down