-
-
Notifications
You must be signed in to change notification settings - Fork 18.4k
DOC: Series.rolling and DataFrame.rolling share docstring #45969
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
Comments
Hi, thanks for your report. The drop and dropna functions have one implementation for Series and DataFrame each while for rolling aggregations there is only one implementation. Hence the identical dostring. Not sure if we can fix this easily. |
#47109 adds docs for all Series functions that take an |
It does, thank you! |
the PR has not been merged |
Pandas version checks
main
hereLocation of the documentation
https://pandas.pydata.org/docs/reference/api/pandas.Series.rolling.html?highlight=series%20rolling#pandas.Series.rolling
Documentation problem
The documentation of the Series function contains references to axis, which makes no sense for a Series (which is one-dimensional). It also refers to single vs. table functionality, which again makes no sense for a Series (which is single-only).
I can see that in cases like drop and dropna, axis exists as a parameter, but clearly states that there is only one axis. In other documentation (such as groupby) the series documentation invites both row and column axis.
Suggested fix for documentation
The Series documentation for rolling should follow the pattern of explaining axis as provided by drop/dropna. All Series functions with an axis parameter should be checked and fixed if necessary.
The text was updated successfully, but these errors were encountered: