-
-
Notifications
You must be signed in to change notification settings - Fork 2k
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
base: main
Are you sure you want to change the base?
docs(python): Adds cancellable queries #18041
Conversation
docs/user-guide/lazy/execution.md
Outdated
|
||
!!! warning "background mode is **unstable**" | ||
|
||
Background mode may be changed at any point as a breaking change. |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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:
polars/py-polars/polars/lazyframe/frame.py
Lines 1882 to 1884 in ca6d46c
.. warning:: | |
Background mode is considered **unstable**. It may be changed | |
at any point without it being considered a breaking change. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
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. |
@coastalwhite Are you okay with the updated PR? It matches the wording from polars/py-polars/polars/lazyframe/frame.py Lines 1882 to 1884 in ca6d46c
|
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.