Skip to content

DOC: mad description incorrectly includes 'numeric_only' #29079

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

Closed
stackedsax opened this issue Oct 18, 2019 · 3 comments · Fixed by #31641
Closed

DOC: mad description incorrectly includes 'numeric_only' #29079

stackedsax opened this issue Oct 18, 2019 · 3 comments · Fixed by #31641
Labels
Milestone

Comments

@stackedsax
Copy link

Problem description

I noticed a small mismatch between the function signature of mad and its description here:

The function signature is correct:

DataFrame.mad(self, axis=None, skipna=None, level=None)

The description, meanwhile, includes 'numeric_only':

numeric_only : bool, default None
Include only float, int, boolean columns. If None, will attempt to use everything, then use only numeric data. Not implemented for Series.

Passing the numeric_only parameter to mad will throw an error, as one would expect.

It looks like both mad and compound are using the @Appender(_num_doc) decorator, which points to a description that includes the numeric_only parameter even though neither of those methods use numeric_only.

The compound method is being deprecated, so that may be less of an issue.

There are a couple of different ways I could think to fix it, but I just wanted to confirm that I had this right before I did anything.

@r0cketr1kky
Copy link
Contributor

Hi, I would like to work on this.
Does this mean I have to remove the numeric only parameter from the mad function in the docs?

@stackedsax
Copy link
Author

Hi @r0cketr1kky. As I understand it, yes. I was just checking that I understood it correctly, though!

@r0cketr1kky
Copy link
Contributor

Thanks a lot @stackedsax

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants