Skip to content

DOC: Removed numeric_only parameter from pd.DataFrame.mad docs #31641

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

Merged
merged 3 commits into from
Feb 9, 2020

Conversation

r0cketr1kky
Copy link
Contributor

@r0cketr1kky r0cketr1kky changed the title Removed numeric_only parameter from pd.DataFrame.mad docs DOC: Removed numeric_only parameter from pd.DataFrame.mad docs Feb 4, 2020
@@ -10315,10 +10315,6 @@ def _doc_parms(cls):
level : int or level name, default None
If the axis is a MultiIndex (hierarchical), count along a
particular level, collapsing into a %(name1)s.
numeric_only : bool, default None
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removing this will remove numeric_only for all other statistical function that actually accept numeric_only. We only want to remove this for mad

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense...I shall correct my mistake. Thank you for guiding me @mroeschke

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please review this commit!

----------
axis : %(axis_descr)s
Axis for the function to be applied on.
skipna : bool, default True
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @r0cketr1kky

Isn't the default for skipna None rather than True?

def mad(self, axis=None, skipna=None, level=None):

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, you're right. I will change this too.

Comment on lines 10344 to 10345
**kwargs
Additional keyword arguments to be passed to the function.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this function accept kwargs?

def mad(self, axis=None, skipna=None, level=None):

Copy link
Contributor Author

@r0cketr1kky r0cketr1kky Feb 4, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, it doesn't. I will remove this as well.

Copy link
Contributor Author

@r0cketr1kky r0cketr1kky Feb 4, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've updated the file. Please review it!

@r0cketr1kky
Copy link
Contributor Author

r0cketr1kky commented Feb 4, 2020

Please review this @MarcoGorelli @mroeschke

@r0cketr1kky r0cketr1kky requested a review from mroeschke February 4, 2020 13:55
@MarcoGorelli
Copy link
Member

I think it's fine, could you include a screenshot of the documentation?

Inside the doc folder, run

python make.py clean
python make.py --single pandas.DataFrame.mad

(see building the documentation)

@r0cketr1kky
Copy link
Contributor Author

r0cketr1kky commented Feb 4, 2020

Screenshot from 2020-02-05 04-59-59

Hi, I'm getting the following error when I run "python make.py clean"
When I ran "python3 make.py clean", I got an error saying "ModuleNotFoundError: No module named 'pandas._libs.tslibs.conversion' "

@mroeschke
Copy link
Member

@r0cketr1kky you'll need to build the c extensions: https://pandas-docs.github.io/pandas-docs-travis/development/contributing.html#creating-a-python-environment

@jreback jreback added the Docs label Feb 5, 2020
@r0cketr1kky
Copy link
Contributor Author

r0cketr1kky commented Feb 5, 2020

Documentation screenshot @MarcoGorelli :

Screenshot from 2020-02-05 06-37-33

P.S. Thanks for the link @mroeschke . This helped me.

@r0cketr1kky
Copy link
Contributor Author

Please review this!

@r0cketr1kky
Copy link
Contributor Author

r0cketr1kky commented Feb 5, 2020

How long does it take to merge this PR?

@MarcoGorelli
Copy link
Member

@r0cketr1kky I don't have write-access to the repo, and I presume that those who do are prioritising other work. Please be patient, I'm pretty sure this will get merged

@r0cketr1kky
Copy link
Contributor Author

Sure, thanks a lot for assisting me!

@jreback jreback added this to the 1.1 milestone Feb 9, 2020
@jreback jreback merged commit 0aad719 into pandas-dev:master Feb 9, 2020
@jreback
Copy link
Contributor

jreback commented Feb 9, 2020

thanks @r0cketr1kky

if you'd canvas the other operations that use _num_doc to see if any need changing would be great.

@r0cketr1kky
Copy link
Contributor Author

r0cketr1kky commented May 15, 2020

Ahh I just saw this comment @jreback I'm having a busy semester :(
Nevertheless thank you @Bharat123rox for this commit 👍

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 this pull request may close these issues.

DOC: mad description incorrectly includes 'numeric_only'
4 participants