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.

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

docs(python): Fix incorrect stated value of include_nulls in DataFrame.update docstring #16701

Merged
merged 2 commits into from
Jun 4, 2024

Conversation

bertiewooster
Copy link
Contributor

@bertiewooster bertiewooster commented Jun 4, 2024

Change from False to True in

Use include_nulls=True to overwrite values in this frame with null values in the other frame.

Fixes #16379. Documentation is at https://docs.pola.rs/py-polars/html/reference/dataframe/api/polars.DataFrame.update.html#polars.DataFrame.update.

@github-actions github-actions bot added documentation Improvements or additions to documentation python Related to Python Polars labels Jun 4, 2024
Copy link

codecov bot commented Jun 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.49%. Comparing base (c506d1f) to head (a25c344).
Report is 12 commits behind head on main.

Current head a25c344 differs from pull request most recent head f085d0a

Please upload reports for the commit f085d0a to get more accurate results.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #16701      +/-   ##
==========================================
+ Coverage   81.47%   81.49%   +0.02%     
==========================================
  Files        1416     1416              
  Lines      186889   186906      +17     
  Branches     3021     3026       +5     
==========================================
+ Hits       152259   152313      +54     
+ Misses      34097    34060      -37     
  Partials      533      533              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@stinodego stinodego left a comment

Choose a reason for hiding this comment

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

Thanks for the fix! The docstring was indeed incorrect.

I opted to remove that paragraph altogether and move the description to the parameter description, where it should be.

@stinodego stinodego merged commit 34d6fa3 into pola-rs:main Jun 4, 2024
14 checks passed
@stinodego stinodego changed the title docs(python): Fix stated value of include_nulls in DataFrame.update docs(python): Fix stated value of include_nulls in DataFrame.update Jun 7, 2024
@stinodego stinodego changed the title docs(python): Fix stated value of include_nulls in DataFrame.update docs(python): Fix incorrect stated value of include_nulls in DataFrame.update docstring Jun 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation python Related to Python Polars
Projects
None yet
Development

Successfully merging this pull request may close these issues.

wrong documentation in DataFrame.update
2 participants