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): Reword "how" param docstring entry for 'semi' and 'anti' join types for clarity #17843

Merged

Conversation

implicit-apparatus
Copy link
Contributor

See #17782
I hope this slight rewording makes it clearer that 'semi' and 'anti' do not return rows of the right table.

Copy link
Collaborator

@alexander-beedie alexander-beedie left a comment

Choose a reason for hiding this comment

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

I made a few minor adjustments to better match the other descriptions; if you can merge these tweaks then it looks good to me - thanks👌

py-polars/polars/lazyframe/frame.py Outdated Show resolved Hide resolved
py-polars/polars/lazyframe/frame.py Outdated Show resolved Hide resolved
py-polars/polars/dataframe/frame.py Outdated Show resolved Hide resolved
py-polars/polars/dataframe/frame.py Outdated Show resolved Hide resolved
@alexander-beedie alexander-beedie changed the title docs: Reword documentation of join make strategy 'semi' and 'anti' cl… docs(python): Reword "how" join doctstring entry for 'semi' and 'anti' types for clarity Jul 24, 2024
@github-actions github-actions bot added documentation Improvements or additions to documentation python Related to Python Polars and removed title needs formatting labels Jul 24, 2024
@alexander-beedie alexander-beedie changed the title docs(python): Reword "how" join doctstring entry for 'semi' and 'anti' types for clarity docs(python): Reword "how" param docstring entry for 'semi' and 'anti' join types for clarity Jul 24, 2024
Copy link

codecov bot commented Jul 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.49%. Comparing base (e96dd26) to head (ea5e50a).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #17843   +/-   ##
=======================================
  Coverage   80.49%   80.49%           
=======================================
  Files        1504     1504           
  Lines      197156   197162    +6     
  Branches     2806     2806           
=======================================
+ Hits       158704   158710    +6     
  Misses      37931    37931           
  Partials      521      521           

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

@alexander-beedie alexander-beedie merged commit c537ba3 into pola-rs:main Jul 24, 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.

2 participants