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): Ensure consistent docstring warning in fill_nan methods (pointing out that nan isn't null) #16061

Merged
merged 1 commit into from
May 6, 2024

Conversation

alexander-beedie
Copy link
Collaborator

@alexander-beedie alexander-beedie commented May 5, 2024

Closes #16055.

  • Turns out we already had docstring warnings to draw attention to nan not being null, but only on the DataFrame/LazyFrame fill_nan methods, not the Expression or Series equivalents - now present on all.
  • Made Expr an explicit part of the typing, since it is supported (and already covered by tests).
  • Added some bonus See Also sections to further increase visibility.

…ds (pointing out that it isn't `fill_null`)
@github-actions github-actions bot added documentation Improvements or additions to documentation python Related to Python Polars labels May 5, 2024
@alexander-beedie alexander-beedie changed the title docs(python): Ensure consistent docstring warning in fill_nan methods (pointing out that it isn't fill_null) docs(python): Ensure consistent docstring warning in fill_nan methods (pointing out that nan isn't null) May 5, 2024
Copy link

codecov bot commented May 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.97%. Comparing base (b57f8ea) to head (612d9b0).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #16061   +/-   ##
=======================================
  Coverage   80.97%   80.97%           
=======================================
  Files        1386     1386           
  Lines      178385   178382    -3     
  Branches     3060     3059    -1     
=======================================
+ Hits       144446   144450    +4     
+ Misses      33450    33444    -6     
+ Partials      489      488    -1     
Flag Coverage Δ
python 74.52% <ø> (+<0.01%) ⬆️
rust 78.15% <ø> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@ritchie46
Copy link
Member

Yeap, we keep educating. :)

@ritchie46 ritchie46 merged commit 421db23 into pola-rs:main May 6, 2024
19 checks passed
@alexander-beedie alexander-beedie deleted the fill-null-nan-warnings branch May 7, 2024 05:25
Wouittone pushed a commit to Wouittone/polars that referenced this pull request Jun 22, 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.

fill_null doesn't support expr
2 participants