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.

Sign up for GitHub

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
Merged

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

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
190faac
Update generic.py
r0cketr1kky Feb 4, 2020
8b53292
Updated generic.py
r0cketr1kky Feb 4, 2020
4227ba4
Updated generic.py
r0cketr1kky Feb 4, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion pandas/core/generic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9960,7 +9960,7 @@ def _add_numeric_operations(cls):
see_also="",
examples="",
)
@Appender(_num_doc)
@Appender(_num_doc_mad)
def mad(self, axis=None, skipna=None, level=None):
if skipna is None:
skipna = True
Expand Down Expand Up @@ -10329,6 +10329,28 @@ def _doc_parms(cls):
%(examples)s
"""

_num_doc_mad = """
%(desc)s

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

Exclude NA/null values when computing the result.
level : int or level name, default None
If the axis is a MultiIndex (hierarchical), count along a
particular level, collapsing into a %(name1)s.
**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 •
edited
Loading

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 •
edited
Loading

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!


Returns
-------
%(name1)s or %(name2)s (if level specified)\
%(see_also)s\
%(examples)s
"""

_num_ddof_doc = """
%(desc)s

Expand Down