Skip to content
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

Jump to bottom

DOC: Removal of return variable names [WIP] #25123

Merged
merged 1 commit into from
Feb 4, 2019
Merged

DOC: Removal of return variable names [WIP] #25123

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 10 additions & 12 deletions pandas/core/generic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9994,8 +9994,7 @@ def _add_numeric_operations(cls):
cls, 'all', name, name2, axis_descr, _all_desc, nanops.nanall,
_all_see_also, _all_examples, empty_value=True)

@Substitution(outname='mad',
desc="Return the mean absolute deviation of the values "
@Substitution(desc="Return the mean absolute deviation of the values "
"for the requested axis.",
name1=name, name2=name2, axis_descr=axis_descr,
min_count='', see_also='', examples='')
Expand Down Expand Up @@ -10036,8 +10035,7 @@ def mad(self, axis=None, skipna=None, level=None):
"ddof argument",
nanops.nanstd)

@Substitution(outname='compounded',
desc="Return the compound percentage of the values for "
@Substitution(desc="Return the compound percentage of the values for "
"the requested axis.", name1=name, name2=name2,
axis_descr=axis_descr,
min_count='', see_also='', examples='')
Expand Down Expand Up @@ -10274,7 +10272,7 @@ def _doc_parms(cls):

Returns
-------
%(outname)s : %(name1)s or %(name2)s (if level specified)
%(name1)s or %(name2)s (if level specified)
%(see_also)s
%(examples)s\
"""
Expand All @@ -10300,7 +10298,7 @@ def _doc_parms(cls):

Returns
-------
%(outname)s : %(name1)s or %(name2)s (if level specified)\n"""
%(name1)s or %(name2)s (if level specified)\n"""

_bool_doc = """
%(desc)s
Expand Down Expand Up @@ -10419,7 +10417,7 @@ def _doc_parms(cls):

Returns
-------
%(outname)s : %(name1)s or %(name2)s\n
%(name1)s or %(name2)s\n
See Also
--------
core.window.Expanding.%(accum_func_name)s : Similar functionality
Expand Down Expand Up @@ -10912,7 +10910,7 @@ def _doc_parms(cls):

def _make_min_count_stat_function(cls, name, name1, name2, axis_descr, desc,
f, see_also='', examples=''):
@Substitution(outname=name, desc=desc, name1=name1, name2=name2,
@Substitution(desc=desc, name1=name1, name2=name2,
axis_descr=axis_descr, min_count=_min_count_stub,
see_also=see_also, examples=examples)
@Appender(_num_doc)
Expand Down Expand Up @@ -10940,7 +10938,7 @@ def stat_func(self, axis=None, skipna=None, level=None, numeric_only=None,

def _make_stat_function(cls, name, name1, name2, axis_descr, desc, f,
see_also='', examples=''):
@Substitution(outname=name, desc=desc, name1=name1, name2=name2,
@Substitution(desc=desc, name1=name1, name2=name2,
axis_descr=axis_descr, min_count='', see_also=see_also,
examples=examples)
@Appender(_num_doc)
Expand All @@ -10964,7 +10962,7 @@ def stat_func(self, axis=None, skipna=None, level=None, numeric_only=None,


def _make_stat_function_ddof(cls, name, name1, name2, axis_descr, desc, f):
@Substitution(outname=name, desc=desc, name1=name1, name2=name2,
@Substitution(desc=desc, name1=name1, name2=name2,
axis_descr=axis_descr)
@Appender(_num_ddof_doc)
def stat_func(self, axis=None, skipna=None, level=None, ddof=1,
Expand All @@ -10985,7 +10983,7 @@ def stat_func(self, axis=None, skipna=None, level=None, ddof=1,

def _make_cum_function(cls, name, name1, name2, axis_descr, desc,
accum_func, accum_func_name, mask_a, mask_b, examples):
@Substitution(outname=name, desc=desc, name1=name1, name2=name2,
@Substitution(desc=desc, name1=name1, name2=name2,
axis_descr=axis_descr, accum_func_name=accum_func_name,
examples=examples)
@Appender(_cnum_doc)
Expand Down Expand Up @@ -11020,7 +11018,7 @@ def cum_func(self, axis=None, skipna=True, *args, **kwargs):

def _make_logical_function(cls, name, name1, name2, axis_descr, desc, f,
see_also, examples, empty_value):
@Substitution(outname=name, desc=desc, name1=name1, name2=name2,
@Substitution(desc=desc, name1=name1, name2=name2,
axis_descr=axis_descr, see_also=see_also, examples=examples,
empty_value=empty_value)
@Appender(_bool_doc)
Expand Down