docs(python): Improve docstrings rolling functions #9215
Merged
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
github-actions
bot
added
python
zundertj
changed the title
2 tasks
MarcoGorelli
reviewed
Jun 4, 2023
zundertj
force-pushed
the
rolling_closed_right
branch
from
c903446 to
3f39ca4
Compare
zundertj
changed the title
github-actions
bot
added
the
documentation
zundertj
requested review from
ritchie46,
stinodego and
alexander-beedie
as code owners
MarcoGorelli
requested changes
Jun 4, 2023
zundertj
force-pushed
the
rolling_closed_right
branch
from
5a82720 to
e3227ea
Compare
|
Sorry for the delay, have been on hols. That wording is better indeed, fixed. |
MarcoGorelli
requested changes
Jun 17, 2023
MarcoGorelli
requested changes
Jun 18, 2023
MarcoGorelli
approved these changes
Jun 19, 2023
c-peters
pushed a commit
to c-peters/polars
that referenced
this pull request
Jul 14, 2023
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.
The
closedargument is only used ifbyis set. In this PR we update the docstrings to reflect that, as well as put the default behaviour for how the time window behaves, i.e. whenbyis not set, first in the docstring.