DOC: Closed parameter not intuitively documented in DataFrame.rolling Part 2 The Window Strikes Back #60844
Conversation
There was a problem hiding this comment.
Thanks for the PR! In addition, can we fix some of what was introduced in #60832. It seems to me the closed argument does not render the way I believe was intended.
Sphinx needs a blank line to induce a line break in the resulting html.
In addition, I think the notation / language here can be tightened up.
If
'right', (First, Last] the last point in the window is included in the calculations.
In the above, (First, Last] is inserted mid-sentence without any reference. I'd suggest
If
right, uses the window(first, last]meaning the last point is included in the calculations.
|
|
||
| If an integer, the fixed number of observations used for | ||
| each window. | ||
| If an integer, the delta between the start and end of each window. |
There was a problem hiding this comment.
What do you think about adding "The number of points in the window depends on the closed argument".
There was a problem hiding this comment.
I like it, though I do think it would require a proper understanding of the closed argument to actually understand the implications on the size (i.e the example where the closed param is set to neither and can result in no window being calculated since the number of points is too few)
…s into change-closed-docs
I agree with your comments and have updated the formatting as well. Thanks for pointing out the issue with the line break. |
doc/source/whatsnew/vX.X.X.rstfile if fixing a bug or adding a new feature.