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): Include warning in docstrings that accessing LazyFrame properties may be expensive #16618

Merged
merged 1 commit into from
May 31, 2024

Conversation

stinodego
Copy link
Member

@stinodego stinodego commented May 31, 2024

Ref #16328

Until we update the API, we can at least include a warning in the docs for our users.

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

codecov bot commented May 31, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.49%. Comparing base (d7b4f72) to head (89a59a0).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #16618      +/-   ##
==========================================
- Coverage   81.51%   81.49%   -0.02%     
==========================================
  Files        1414     1414              
  Lines      185906   185906              
  Branches     3027     3027              
==========================================
- Hits       151535   151507      -28     
- Misses      33840    33868      +28     
  Partials      531      531              

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

@stinodego stinodego changed the title docs(python): Warn that accessing LazyFrame properties may be expensive docs(python): Include warning in docstrings that accessing LazyFrame properties may be expensive May 31, 2024
@stinodego stinodego merged commit 7c7e834 into main May 31, 2024
17 checks passed
@stinodego stinodego deleted the lf-property-docs branch May 31, 2024 11:05
@c-peters c-peters added the accepted Ready for implementation label Jun 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted Ready for implementation documentation Improvements or additions to documentation python Related to Python Polars
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants