Skip to content

DOC: update the DataFrame.update() docstring #20201

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 15 commits into from
Mar 13, 2018
Merged

DOC: update the DataFrame.update() docstring #20201

Changes from 2 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
10f998d
DOC: Improved the docstring of DataFrame.update()
kantologist Mar 10, 2018
5d9d44b
Merge remote-tracking branch 'upstream/master' into docstring_update
kantologist Mar 10, 2018
3965924
Merge remote-tracking branch 'upstream/master' into docstring_update
kantologist Mar 10, 2018
714ead4
DOC: Improved the docstring of DataFrame.update()
kantologist Mar 10, 2018
ee07bc6
DOC: Improved the docstring of DataFrame.join()
kantologist Mar 11, 2018
6443994
Merge remote-tracking branch 'upstream/master' into docstring_update
kantologist Mar 11, 2018
2ce7982
DOC: Improved the docstring of DataFrame.join()
kantologist Mar 11, 2018
ff0b3fa
Update returns.
TomAugspurger Mar 12, 2018
4bb134d
Merge remote-tracking branch 'upstream/master' into docstring_update
kantologist Mar 12, 2018
8167356
Merge remote-tracking branch 'upstream/master' into docstring_update
kantologist Mar 12, 2018
8838631
DOC: Improved the docstring of DataFrame.update()
kantologist Mar 12, 2018
77b7e3b
DOC: Improved the docstring of DataFrame.update()
kantologist Mar 12, 2018
4c2e352
DOC: Improve the docstring of DataFrame.update()
kantologist Mar 13, 2018
eade529
Merge remote-tracking branch 'upstream/master' into docstring_update
kantologist Mar 13, 2018
ce18a26
Update frame.py
jorisvandenbossche Mar 13, 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
20 changes: 17 additions & 3 deletions pandas/core/frame.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4207,17 +4207,23 @@ def update(self, other, join='left', overwrite=True, filter_func=None,
raise_conflict=False):
"""
Modify DataFrame in place using non-NA values from passed
Copy link
Contributor

Choose a reason for hiding this comment

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

May have to reword this so the first line isn't too long? Does the validation script complain about this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The validation script actually did not complain, but I'll try to adjust it.

DataFrame. Aligns on indices
DataFrame.

Aligns on indices.

Parameters
----------
other : DataFrame, or object coercible into a DataFrame
Index should be similar to one of the columns in this one. If a
Copy link
Member

Choose a reason for hiding this comment

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

I don't really understand "Index should be similar to one of the columns in this one". What do you want to say here?

Series is passed, its name attribute must be set, and that will be
used as the column name in the resulting joined DataFrame.
join : {'left'}, default 'left'
Indicates which column values overwrite.
Copy link
Contributor

Choose a reason for hiding this comment

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

Is join='right' valid? Can you do some exploration on what happens?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's actually not valid. I tried it.

Copy link
Member

Choose a reason for hiding this comment

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

I think you can say "Only left join is implemented, keeping the index and columns of the original object"

overwrite : boolean, default True
If True then overwrite values for common keys in the calling frame
If True then overwrite values for common keys in the calling frame.
Copy link
Member

Choose a reason for hiding this comment

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

and what if False?

Copy link
Member

Choose a reason for hiding this comment

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

I think it that case only NA values in the calling object are updated

filter_func : callable(1d-array) -> 1d-array<boolean>, default None
Copy link
Member

Choose a reason for hiding this comment

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

"default None" -> "optional"

Can choose to replace values other than NA. Return True for values
that should be updated
that should be updated.
raise_conflict : boolean
If True, will raise an error if the DataFrame and other both
contain data in the same place.
Expand Down Expand Up @@ -4276,6 +4282,14 @@ def update(self, other, join='left', overwrite=True, filter_func=None,
0 1 4.0
1 2 500.0
2 3 6.0

See also
Copy link
Contributor

Choose a reason for hiding this comment

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

See Also (note capitalization)

should go before the examples.

--------
DataFrame.merge : For column(s)-on-columns(s) operations

Returns
-------
updated : DataFrame
Copy link
Contributor

Choose a reason for hiding this comment

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

Rerturns goes right after the Parameters section.

"""
import pandas.core.computation.expressions as expressions
# TODO: Support other joins
Expand Down