docs(python): Update leftover references of by parameter to group_by in DataFrame/LazyFrame.upsample/group_by_dynamic/rolling
#15527
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
henryharbeck
requested review from
ritchie46,
stinodego,
c-peters,
alexander-beedie,
MarcoGorelli and
reswqa
as code owners
github-actions
bot
added
documentation
henryharbeck
commented
Apr 7, 2024
| @@ -3242,7 +3242,7 @@ def rolling( | |||
| """ | |||
| Create rolling groups based on a temporal or integer column. | |||
|
|
|||
| Different from a `dynamic_group_by` the windows are now determined by the | |||
| Different from a `group_by_dynamic` the windows are now determined by the | |||
There was a problem hiding this comment.
Drive by typo fix. Now aligns with DataFrame docstring.
henryharbeck
commented
Apr 7, 2024
| of which will be sorted by `index_column` (but note that if `by` columns are | ||
| passed, it will only be sorted within each `by` group). | ||
| of which will be sorted by `index_column` (but note that if `group_by` | ||
| columns are passed, it will only be sorted within each group). |
There was a problem hiding this comment.
I think that the by in "...within each by group)." isn't needed anymore.
The group_by parameter name makes it very obvious what the group is.
MarcoGorelli
approved these changes
Apr 7, 2024
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #15527 +/- ##
=======================================
Coverage 81.14% 81.15%
=======================================
Files 1362 1362
Lines 175007 175007
Branches 2533 2533
=======================================
+ Hits 142014 142031 +17
+ Misses 32509 32491 -18
- Partials 484 485 +1 ☔ View full report in Codecov by Sentry. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
#14840 renamed the
byparameter togroup_byinDataFrame.upsample/group_by_dynamic/rollingLazyFrame.group_by_dynamic/rollingThis PR cleans up remaining references in the docstrings to the old
byparamter.