Skip to content

DOC: Improve documentation of kwargs for NumPy compatibility #48423

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

Open
rhshadrach opened this issue Sep 6, 2022 · 0 comments
Open

DOC: Improve documentation of kwargs for NumPy compatibility #48423

rhshadrach opened this issue Sep 6, 2022 · 0 comments
Labels
Compat pandas objects compatability with Numpy or Python functions Docs Enhancement

Comments

@rhshadrach
Copy link
Member

rhshadrach commented Sep 6, 2022

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.

@rhshadrach rhshadrach added Enhancement Docs Compat pandas objects compatability with Numpy or Python functions labels Sep 6, 2022
@rhshadrach rhshadrach added this to the Contributions Welcome milestone Sep 6, 2022
@mroeschke mroeschke removed this from the Contributions Welcome milestone Oct 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Compat pandas objects compatability with Numpy or Python functions Docs Enhancement
Projects
None yet
Development

No branches or pull requests

2 participants