Skip to content

DOC: Improve documentation of kwargs for NumPy compatibility #48423

Open
@rhshadrach

Description

@rhshadrach

xref #48277

In certain locations, the API docs give very little information on kwargs that exist only for NumPy compatibility, e.g.

https://pandas.pydata.org/pandas-docs/dev/reference/api/pandas.DataFrame.sum.html

Additional keyword arguments to be passed to the function.

https://pandas.pydata.org/pandas-docs/dev/reference/api/pandas.DataFrame.clip.html

Additional keywords have no effect but might be accepted for compatibility with numpy.

This is a bit terse to me; I think it would be useful to have a section of the FAQ explaining this in a bit more detail, and to link there from appropriate docstrings.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Compatpandas objects compatability with Numpy or Python functionsDocsEnhancement

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions