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.

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

DOC: resolve all GL03 docstring validation errors #25525

Merged
merged 7 commits into from
Mar 10, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions ci/code_checks.sh
Original file line number Diff line number Diff line change
Expand Up @@ -241,8 +241,8 @@ fi
### DOCSTRINGS ###
if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then

MSG='Validate docstrings (GL06, GL07, GL09, SS04, SS05, PR03, PR04, PR05, PR10, EX04, RT04, RT05, SA05)' ; echo $MSG
$BASE_DIR/scripts/validate_docstrings.py --format=azure --errors=GL06,GL07,GL09,SS04,SS05,PR03,PR04,PR05,PR10,EX04,RT04,RT05,SA05
MSG='Validate docstrings (GL03, GL06, GL07, GL09, SS04, SS05, PR03, PR04, PR05, PR10, EX04, RT04, RT05, SA05)' ; echo $MSG
$BASE_DIR/scripts/validate_docstrings.py --format=azure --errors=GL03,GL06,GL07,GL09,SS04,SS05,PR03,PR04,PR05,PR10,EX04,RT04,RT05,SA05
RET=$(($RET + $?)) ; echo $MSG "DONE"

fi
Expand Down
1 change: 0 additions & 1 deletion pandas/_libs/tslibs/timedeltas.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -1156,7 +1156,6 @@ class Timedelta(_Timedelta):
Notes
-----
The ``.value`` attribute is always in ns.

"""
def __new__(cls, object value=_no_input, unit=None, **kwargs):
cdef _Timedelta td_base
Expand Down
2 changes: 1 addition & 1 deletion pandas/core/arrays/datetimes.py
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ def f(self):
return result

f.__name__ = name
f.__doc__ = "\n{}\n".format(docstring)
f.__doc__ = docstring
return property(f)


Expand Down
1 change: 0 additions & 1 deletion pandas/core/arrays/sparse.py
Original file line number Diff line number Diff line change
Expand Up @@ -541,7 +541,6 @@ class SparseArray(PandasObject, ExtensionArray, ExtensionOpsMixin):
3. ``data.dtype.fill_value`` if `fill_value` is None and `dtype`
is not a ``SparseDtype`` and `data` is a ``SparseArray``.


kind : {'integer', 'block'}, default 'integer'
The type of storage for sparse locations.

Expand Down
1 change: 0 additions & 1 deletion pandas/core/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -870,7 +870,6 @@ def to_numpy(self, dtype=None, copy=False):

.. versionadded:: 0.24.0


Parameters
----------
dtype : str or numpy.dtype, optional
Expand Down
1 change: 0 additions & 1 deletion pandas/core/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -651,7 +651,6 @@ def _build_option_description(k):
.format(rkey=d.rkey if d.rkey else ''))
s += u(')')

s += '\n\n'
return s


Expand Down
2 changes: 0 additions & 2 deletions pandas/core/frame.py
Original file line number Diff line number Diff line change
Expand Up @@ -2184,7 +2184,6 @@ def to_html(self, buf=None, columns=None, col_space=None, header=True,
Convert URLs to HTML links.

.. versionadded:: 0.24.0

%(returns)s
See Also
--------
Expand Down Expand Up @@ -6027,7 +6026,6 @@ def unstack(self, level=-1, fill_value=None):
columns, considered measured variables (`value_vars`), are "unpivoted" to
the row axis, leaving just two non-identifier columns, 'variable' and
'value'.

%(versionadded)s
Parameters
----------
Expand Down
14 changes: 3 additions & 11 deletions pandas/core/generic.py
Original file line number Diff line number Diff line change
Expand Up @@ -948,7 +948,6 @@ def swaplevel(self, i=-2, j=-1, axis=0):

The indexes ``i`` and ``j`` are now optional, and default to
the two innermost levels of the index.

"""
axis = self._get_axis_number(axis)
result = self.copy()
Expand Down Expand Up @@ -4951,9 +4950,7 @@ def pipe(self, func, *args, **kwargs):

_shared_docs['aggregate'] = dedent("""
Aggregate using one or more operations over the specified axis.

WillAyd marked this conversation as resolved.
Show resolved Hide resolved
%(versionadded)s

Parameters
----------
func : function, str, list or dict
Expand Down Expand Up @@ -4983,17 +4980,13 @@ def pipe(self, func, *args, **kwargs):
* DataFrame : when DataFrame.agg is called with several functions

Return scalar, Series or DataFrame.

%(see_also)s

Notes
-----
`agg` is an alias for `aggregate`. Use the alias.

A passed user-defined-function will be passed a Series for evaluation.

%(examples)s
""")
%(examples)s""")

_shared_docs['transform'] = ("""
Call ``func`` on self producing a %(klass)s with transformed values
Expand Down Expand Up @@ -10307,7 +10300,7 @@ def _doc_parms(cls):

Returns
-------
%(name1)s or %(name2)s (if level specified)
%(name1)s or %(name2)s (if level specified)\
jamescobonkerr marked this conversation as resolved.
Show resolved Hide resolved
%(see_also)s
%(examples)s\
"""
Expand Down Expand Up @@ -10464,8 +10457,7 @@ def _doc_parms(cls):
%(name2)s.cumsum : Return cumulative sum over %(name2)s axis.
%(name2)s.cumprod : Return cumulative product over %(name2)s axis.

%(examples)s
"""
%(examples)s"""

_cummin_examples = """\
Examples
Expand Down
4 changes: 1 addition & 3 deletions pandas/core/groupby/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -126,9 +126,7 @@ class where members are defined.
property_wrapper_template = \
"""@property
def %(name)s(self) :
\"""
%(doc)s
\"""
\"""%(doc)s\"""
return self.__getattr__('%(name)s')"""

for name in whitelist:
Expand Down
11 changes: 1 addition & 10 deletions pandas/core/groupby/groupby.py
Original file line number Diff line number Diff line change
Expand Up @@ -221,8 +221,7 @@ class providing the base-class of operations.

Examples
--------
%(examples)s
"""
%(examples)s"""

_transform_template = """
Call function producing a like-indexed %(klass)s on each group and
Expand Down Expand Up @@ -1106,9 +1105,7 @@ def mean(self, *args, **kwargs):
Returns
-------
pandas.Series or pandas.DataFrame

%(see_also)s

Examples
--------
>>> df = pd.DataFrame({'A': [1, 1, 2, 1, 2],
Expand Down Expand Up @@ -1564,9 +1561,7 @@ def nth(self, n, dropna=None):
dropna : None or str, optional
apply the specified dropna operation before counting which row is
the nth row. Needs to be None, 'any' or 'all'

%(see_also)s

Examples
--------

Expand Down Expand Up @@ -2139,9 +2134,7 @@ def head(self, n=5):

Essentially equivalent to ``.apply(lambda x: x.head(n))``,
except ignores as_index flag.

%(see_also)s

Examples
--------

Expand All @@ -2167,9 +2160,7 @@ def tail(self, n=5):

Essentially equivalent to ``.apply(lambda x: x.tail(n))``,
except ignores as_index flag.

%(see_also)s

Examples
--------

Expand Down
1 change: 0 additions & 1 deletion pandas/core/indexes/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -3104,7 +3104,6 @@ def reindex(self, target, method=None, level=None, limit=None,
Resulting index.
indexer : np.ndarray or None
Indices of output values in original index.

"""
# GH6552: preserve names when reindexing to non-named target
# (i.e. neither Index nor Series).
Expand Down
1 change: 0 additions & 1 deletion pandas/io/feather_format.py
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,6 @@ def read_feather(path, columns=None, use_threads=True):
Returns
-------
type of object stored in file

"""

feather, pyarrow = _try_import()
Expand Down
1 change: 0 additions & 1 deletion pandas/plotting/_misc.py
Original file line number Diff line number Diff line change
Expand Up @@ -303,7 +303,6 @@ def andrews_curves(frame, class_column, ax=None, samples=200, color=None,
Returns
-------
class:`matplotlip.axis.Axes`

"""
from math import sqrt, pi
import matplotlib.pyplot as plt
Expand Down