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): Improve filter documentation #17755

Merged
merged 1 commit into from
Jul 25, 2024

Conversation

atigbadr
Copy link
Contributor

No description provided.

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

codecov bot commented Jul 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.49%. Comparing base (1cea4ea) to head (aca10d7).

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #17755      +/-   ##
==========================================
+ Coverage   80.47%   80.49%   +0.01%     
==========================================
  Files        1503     1503              
  Lines      197002   197002              
  Branches     2795     2795              
==========================================
+ Hits       158537   158575      +38     
+ Misses      37945    37907      -38     
  Partials      520      520              

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

the comparison of two or more columns, please note that in Polars,
any comparison involving null values will always result in null.
As a result, these rows will be filtered out.
Ensure to handle null values appropriately to avoid unintended filtering
Copy link
Member

@ritchie46 ritchie46 Jul 23, 2024

Choose a reason for hiding this comment

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

I think you should mention ne_missing and eq_missing, and I'd rather see an example using those methods as those will include missing values in the comparison.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeap you are right, will do and will update the example.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

@atigbadr atigbadr requested a review from orlp as a code owner July 23, 2024 12:04
@atigbadr atigbadr force-pushed the improve-func-filter-documentation branch from 6cff4e5 to 862e3ed Compare July 23, 2024 12:10
@atigbadr atigbadr force-pushed the improve-func-filter-documentation branch from 862e3ed to aca10d7 Compare July 23, 2024 12:14
@ritchie46 ritchie46 merged commit 903d891 into pola-rs:main Jul 25, 2024
14 checks passed
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.

3 participants