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): Adds cancellable queries #18041

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

thomasjpfan
Copy link
Contributor

Closes #14544

This PR adds an example in the user guide about collect(background=True. The user guide also includes a warning stating that the feature may change at any point.

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

!!! warning "background mode is **unstable**"

Background mode may be changed at any point as a breaking change.
Copy link
Collaborator

Choose a reason for hiding this comment

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

as a non-breaking change

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I can see how the phasing can be unclear. I updated this PR's wording to be the same as the docstring:

.. warning::
Background mode is considered **unstable**. It may be changed
at any point without it being considered a breaking change.

Copy link

codecov bot commented Aug 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.38%. Comparing base (55fc85a) to head (263f04a).
Report is 6 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #18041      +/-   ##
==========================================
- Coverage   80.46%   80.38%   -0.08%     
==========================================
  Files        1496     1496              
  Lines      197174   197480     +306     
  Branches     2820     2820              
==========================================
+ Hits       158655   158747      +92     
- Misses      37997    38211     +214     
  Partials      522      522              

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

@thomasjpfan
Copy link
Contributor Author

@coastalwhite Are you okay with the updated PR? It matches the wording from

.. warning::
Background mode is considered **unstable**. It may be changed
at any point without it being considered a breaking change.

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.

Add docs for using cancellable queries
2 participants