Skip to content

Commit

Permalink
docs(python): Fix stated value of include_nulls in DataFrame.update (#…
Browse files Browse the repository at this point in the history
…16701)

Co-authored-by: Stijn de Gooijer <[email protected]>
  • Loading branch information
bertiewooster and stinodego authored Jun 4, 2024
1 parent ab82b22 commit 34d6fa3
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 9 deletions.
8 changes: 2 additions & 6 deletions py-polars/polars/dataframe/frame.py
Original file line number Diff line number Diff line change
Expand Up @@ -10703,10 +10703,6 @@ def update(
This functionality is considered **unstable**. It may be changed
at any point without it being considered a breaking change.
By default, null values in the right frame are ignored. Use
`include_nulls=False` to overwrite values in this frame with
null values in the other frame.
Parameters
----------
other
Expand All @@ -10725,8 +10721,8 @@ def update(
right_on
Join column(s) of the right DataFrame.
include_nulls
If True, null values from the right dataframe will be used to update the
left dataframe.
Overwrite values in the left frame with null values from the right frame.
If set to `False` (default), null values in the right frame are ignored.
Notes
-----
Expand Down
6 changes: 3 additions & 3 deletions py-polars/polars/lazyframe/frame.py
Original file line number Diff line number Diff line change
Expand Up @@ -6142,7 +6142,7 @@ def update(
include_nulls: bool = False,
) -> Self:
"""
Update the values in this `LazyFrame` with the non-null values in `other`.
Update the values in this `LazyFrame` with the values in `other`.
.. warning::
This functionality is considered **unstable**. It may be changed
Expand All @@ -6166,8 +6166,8 @@ def update(
right_on
Join column(s) of the right DataFrame.
include_nulls
If True, null values from the right DataFrame will be used to update the
left DataFrame.
Overwrite values in the left frame with null values from the right frame.
If set to `False` (default), null values in the right frame are ignored.
Notes
-----
Expand Down

0 comments on commit 34d6fa3

Please sign in to comment.