Skip to content

DOC: Series.rolling and DataFrame.rolling share docstring #45969

Closed
@MichaelTiemannOSC

Description

@MichaelTiemannOSC

Pandas version checks

  • I have checked that the issue still exists on the latest versions of the docs on main here

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    DocsWindowrolling, ewma, expanding

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions