Skip to content

DOC: Improve the docstring of pandas.DataFrame.append() #20267

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

Merged
merged 10 commits into from
Jul 8, 2018
Merged

DOC: Improve the docstring of pandas.DataFrame.append() #20267

Changes from 2 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
4377e47
DOC: Improve the docstring of pandas.DataFrame.append()
Triple0 Mar 11, 2018
01af9d1
DOC: Improve the docstring of pandas.DataFrame.append()
Triple0 Mar 11, 2018
1ffcece
DOC: Improve the docstring of pandas.DataFrame.append()
Triple0 Mar 11, 2018
6c3946a
DOC: Improve the docstring of pandas.DataFrame.assign()
Triple0 Mar 11, 2018
083afcc
DOC: Improve the docstring of pandas.DataFrame.merge()
Triple0 Mar 11, 2018
389d7ee
DOC: Improve the docstring of pandas.DataFrame.merge()
Triple0 Mar 11, 2018
cb78862
DOC fixup
WillAyd Jul 8, 2018
df9e2a8
Merge remote-tracking branch 'upstream/master' into dataframe_olalekan
WillAyd Jul 8, 2018
023ed83
DOC fixup
WillAyd Jul 8, 2018
cb9ee77
Updated copy description
WillAyd Jul 8, 2018
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
6 changes: 3 additions & 3 deletions pandas/core/frame.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5053,8 +5053,9 @@ def infer(x):

def append(self, other, ignore_index=False, verify_integrity=False):
"""
Append rows of `other` to the end of this frame, returning a new
object. Columns not in this frame are added as new columns.
Append rows of `other` to the end of `caller`, returning a new object.
Copy link
Member

Choose a reason for hiding this comment

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

'caller' is not needed to quote (it's not an argument).

Also given this is the docstring specific to DataFrame (not shared with Series), I think we can be more specific. So maybe "calling DataFrame" ? (or is it then too long ?)


Columns not in the caller are added as new columns.
Copy link
Member

Choose a reason for hiding this comment

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

Better but for explicitness say "Columns in other not in caller are ..."


Parameters
----------
Expand Down Expand Up @@ -5136,7 +5137,6 @@ def append(self, other, ignore_index=False, verify_integrity=False):
2 2
3 3
4 4

"""
if isinstance(other, (Series, dict)):
if isinstance(other, dict):
Expand Down