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 docstrings for ewm_* and rolling_* methods #14667

Merged
merged 2 commits into from
Feb 25, 2024

Conversation

MarcoGorelli
Copy link
Collaborator

A few minor things:

  • for rolling, - 1i (1 index count) is already documented, I don't an extra paragraph showing it in bold is warranted
  • for rolling_*, the default is now closed='right', so I think that's what the example should show. I don't think the explanation of closed='left' adds much
  • for ewm_*, note that adjust=True is the default (it's quite a long docstring, easier to see it there than to scroll up to the signature)

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

codecov bot commented Feb 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.79%. Comparing base (849953b) to head (99f0f5b).

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #14667      +/-   ##
==========================================
- Coverage   80.79%   80.79%   -0.01%     
==========================================
  Files        1326     1326              
  Lines      173249   173249              
  Branches     2456     2456              
==========================================
- Hits       139976   139970       -6     
- Misses      32800    32806       +6     
  Partials      473      473              

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

Copy link
Member

@stinodego stinodego left a comment

Choose a reason for hiding this comment

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

Looks good to me, thanks!

@stinodego stinodego changed the title docs(python): assorted ewm_* and rolling_* improvements docs(python): Improve docstrings for ewm_* and rolling_* methods Feb 25, 2024
@stinodego stinodego merged commit b13a7f5 into pola-rs:main Feb 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.

2 participants