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): Change ordering of values in example for cum_max #16456

Merged
merged 1 commit into from
May 23, 2024

Conversation

mdavis-xyz
Copy link
Contributor

The example for cum_max uses an ascending sequence. So cum_max doesn't do anything in that case. In reverse mode it does the same as the non-cumulative sum. This change makes the example data go up and down, so the behaviour of the function is clearer.

(I wasn't able to build polars, even off the main branch. But this change is so trivial, I'm hoping it's fine anyway.)

Copy link

codecov bot commented May 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.44%. Comparing base (2357125) to head (f7fcfab).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #16456      +/-   ##
==========================================
- Coverage   81.44%   81.44%   -0.01%     
==========================================
  Files        1409     1409              
  Lines      184725   184725              
  Branches     2971     2971              
==========================================
- Hits       150452   150447       -5     
- Misses      33753    33758       +5     
  Partials      520      520              

☔ 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.

Good improvement, thanks!

@stinodego stinodego changed the title Docs: Change ordering of values in example for cum_max docs(python): Change ordering of values in example for cum_max May 23, 2024
@stinodego stinodego changed the title docs(python): Change ordering of values in example for cum_max docs(python): Change ordering of values in example for cum_max May 23, 2024
@github-actions github-actions bot added documentation Improvements or additions to documentation python Related to Python Polars labels May 23, 2024
@stinodego stinodego merged commit a4d30b4 into pola-rs:main May 23, 2024
17 checks passed
Wouittone pushed a commit to Wouittone/polars that referenced this pull request Jun 22, 2024
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