From 777fe4cf172b6975f1125f3e9f2bb7b1396bed24 Mon Sep 17 00:00:00 2001 From: zangell44 <42625717+zangell44@users.noreply.github.com> Date: Tue, 12 Feb 2019 18:27:22 -0500 Subject: [PATCH 01/29] pandas.plotting.bootstrap_plot doc updated --- pandas/plotting/_misc.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pandas/plotting/_misc.py b/pandas/plotting/_misc.py index 62a33245f99ef..21592a5b4a0a1 100644 --- a/pandas/plotting/_misc.py +++ b/pandas/plotting/_misc.py @@ -390,7 +390,7 @@ def bootstrap_plot(series, fig=None, size=50, samples=500, **kwds): Returns ------- fig : matplotlib.figure.Figure - Matplotlib figure + Matplotlib figure. See Also -------- From a595cace6b3c72cfcb3faffdb1fed3c533ec8ec5 Mon Sep 17 00:00:00 2001 From: zangell44 <42625717+zangell44@users.noreply.github.com> Date: Tue, 12 Feb 2019 18:41:32 -0500 Subject: [PATCH 02/29] generic aggregate docstring updated --- pandas/core/generic.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/pandas/core/generic.py b/pandas/core/generic.py index c886493f90eaf..c55d37f334fb4 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -4950,10 +4950,10 @@ def pipe(self, func, *args, **kwargs): Returns ------- DataFrame, Series or scalar - If DataFrame.agg is called with a single function, returns a Series - If DataFrame.agg is called with several functions, returns a DataFrame - If Series.agg is called with single function, returns a scalar - If Series.agg is called with several functions, returns a Series + If DataFrame.agg is called with a single function, returns a Series. + If DataFrame.agg is called with several functions, returns a DataFrame. + If Series.agg is called with single function, returns a scalar. + If Series.agg is called with several functions, returns a Series. %(see_also)s From 507d21e3ede7016cc7981bfb32a07a65965823aa Mon Sep 17 00:00:00 2001 From: zangell44 <42625717+zangell44@users.noreply.github.com> Date: Tue, 12 Feb 2019 18:42:49 -0500 Subject: [PATCH 03/29] generic clip method docstring updated --- pandas/core/generic.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pandas/core/generic.py b/pandas/core/generic.py index c55d37f334fb4..d429086a1d75f 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -7235,7 +7235,7 @@ def clip(self, lower=None, upper=None, axis=None, inplace=False, ------- Series or DataFrame Same type as calling object with the values outside the - clip boundaries replaced + clip boundaries replaced. Examples -------- From 950f272306e06a900eabf30c0299ba19b1aeb1b0 Mon Sep 17 00:00:00 2001 From: zangell44 <42625717+zangell44@users.noreply.github.com> Date: Tue, 12 Feb 2019 18:44:25 -0500 Subject: [PATCH 04/29] pandas.series.unique docstring update --- pandas/core/series.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pandas/core/series.py b/pandas/core/series.py index b2011fdcdee98..cf8301a948d53 100644 --- a/pandas/core/series.py +++ b/pandas/core/series.py @@ -1658,7 +1658,7 @@ def unique(self): * Datetime with Timezone * Interval * Sparse - * IntegerNA + * IntegerNA. See Also -------- From ba5120f159f0170ba987747c7a05bb6998be9bf7 Mon Sep 17 00:00:00 2001 From: zangell44 <42625717+zangell44@users.noreply.github.com> Date: Tue, 12 Feb 2019 18:45:25 -0500 Subject: [PATCH 05/29] generic align docstring updated --- pandas/core/generic.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pandas/core/generic.py b/pandas/core/generic.py index d429086a1d75f..6c2cbfd7088f4 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -8386,7 +8386,7 @@ def ranker(data): Returns ------- (left, right) : (%(klass)s, type of other) - Aligned objects + Aligned objects. """) @Appender(_shared_docs['align'] % _shared_doc_kwargs) From 3cd359f23f394b4d063f70f16e264943d0123603 Mon Sep 17 00:00:00 2001 From: zangell44 <42625717+zangell44@users.noreply.github.com> Date: Tue, 12 Feb 2019 18:46:11 -0500 Subject: [PATCH 06/29] generic interpolate docstring updated --- pandas/core/generic.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pandas/core/generic.py b/pandas/core/generic.py index 6c2cbfd7088f4..e11ce6483c08c 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -6657,7 +6657,7 @@ def replace(self, to_replace=None, value=None, inplace=False, limit=None, ------- Series or DataFrame Returns the same object type as the caller, interpolated at - some or all ``NaN`` values + some or all ``NaN`` values. See Also -------- From 0266006b805627e07d990abc4a15b4ef8f5a9db4 Mon Sep 17 00:00:00 2001 From: zangell44 <42625717+zangell44@users.noreply.github.com> Date: Tue, 12 Feb 2019 18:47:23 -0500 Subject: [PATCH 07/29] generic asof docstric update --- pandas/core/generic.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pandas/core/generic.py b/pandas/core/generic.py index e11ce6483c08c..0c9f801838986 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -6877,11 +6877,11 @@ def asof(self, where, subset=None): ------- scalar, Series, or DataFrame - Scalar : when `self` is a Series and `where` is a scalar + Scalar : when `self` is a Series and `where` is a scalar. Series: when `self` is a Series and `where` is an array-like, - or when `self` is a DataFrame and `where` is a scalar + or when `self` is a DataFrame and `where` is a scalar. DataFrame : when `self` is a DataFrame and `where` is an - array-like + array-like. See Also -------- From 86456dd018c96fd19299beb7095f3b87df691e83 Mon Sep 17 00:00:00 2001 From: zangell44 <42625717+zangell44@users.noreply.github.com> Date: Tue, 12 Feb 2019 18:58:11 -0500 Subject: [PATCH 08/29] pandas.tseries.frequencies.to_offset return docstring fix --- pandas/tseries/frequencies.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pandas/tseries/frequencies.py b/pandas/tseries/frequencies.py index f591b24f5b648..4802447cbc99d 100644 --- a/pandas/tseries/frequencies.py +++ b/pandas/tseries/frequencies.py @@ -68,7 +68,7 @@ def to_offset(freq): Returns ------- delta : DateOffset - None if freq is None + None if freq is None. Raises ------ From a86736befb169ee01ae8d21fe1ccd074b8a2e684 Mon Sep 17 00:00:00 2001 From: zangell44 <42625717+zangell44@users.noreply.github.com> Date: Tue, 12 Feb 2019 18:59:12 -0500 Subject: [PATCH 09/29] pandas.Index.reindex return docstring fix --- pandas/core/indexes/base.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pandas/core/indexes/base.py b/pandas/core/indexes/base.py index cf813f4c3030b..e3f9b5712daa7 100644 --- a/pandas/core/indexes/base.py +++ b/pandas/core/indexes/base.py @@ -3100,7 +3100,7 @@ def reindex(self, target, method=None, level=None, limit=None, new_index : pd.Index Resulting index indexer : np.ndarray or None - Indices of output values in original index + Indices of output values in original index. """ # GH6552: preserve names when reindexing to non-named target From 7d57782e080f80ab85e39d8477ba26d1c2774b23 Mon Sep 17 00:00:00 2001 From: zangell44 <42625717+zangell44@users.noreply.github.com> Date: Tue, 12 Feb 2019 19:00:32 -0500 Subject: [PATCH 10/29] indexes/base.py return docstring updates --- pandas/core/indexes/base.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/pandas/core/indexes/base.py b/pandas/core/indexes/base.py index e3f9b5712daa7..f2c8ac6e9b413 100644 --- a/pandas/core/indexes/base.py +++ b/pandas/core/indexes/base.py @@ -1828,7 +1828,7 @@ def isna(self): Returns ------- numpy.ndarray - A boolean array of whether my values are NA + A boolean array of whether my values are NA. See Also -------- @@ -3098,7 +3098,7 @@ def reindex(self, target, method=None, level=None, limit=None, Returns ------- new_index : pd.Index - Resulting index + Resulting index. indexer : np.ndarray or None Indices of output values in original index. @@ -4259,7 +4259,7 @@ def shift(self, periods=1, freq=None): Returns ------- pandas.Index - Shifted index + Shifted index. See Also -------- @@ -4422,7 +4422,7 @@ def set_value(self, arr, key, value): in the target are marked by -1. missing : ndarray of int An indexer into the target of the values not found. - These correspond to the -1 in the indexer array + These correspond to the -1 in the indexer array. """ @Appender(_index_shared_docs['get_indexer_non_unique'] % _index_doc_kwargs) From b47b886871859dd91bb617f7cbc90c7f5d53ba1c Mon Sep 17 00:00:00 2001 From: zangell44 <42625717+zangell44@users.noreply.github.com> Date: Tue, 12 Feb 2019 19:01:53 -0500 Subject: [PATCH 11/29] indexes/multi.py return docstring updates --- pandas/core/indexes/multi.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pandas/core/indexes/multi.py b/pandas/core/indexes/multi.py index e2237afbcac0f..efb77b5d155a1 100644 --- a/pandas/core/indexes/multi.py +++ b/pandas/core/indexes/multi.py @@ -1956,7 +1956,7 @@ def swaplevel(self, i=-2, j=-1): Returns ------- MultiIndex - A new MultiIndex + A new MultiIndex. .. versionchanged:: 0.18.1 @@ -2053,9 +2053,9 @@ def sortlevel(self, level=0, ascending=True, sort_remaining=True): Returns ------- sorted_index : pd.MultiIndex - Resulting index + Resulting index. indexer : np.ndarray - Indices of output values in original index + Indices of output values in original index. """ from pandas.core.sorting import indexer_from_factorized From 63f04689a3580238d39cb620c72f1b1e47257fff Mon Sep 17 00:00:00 2001 From: zangell44 <42625717+zangell44@users.noreply.github.com> Date: Tue, 12 Feb 2019 19:50:52 -0500 Subject: [PATCH 12/29] DataFrame.get_ftype_counts and DataFrame.get_values return docstring update --- pandas/core/generic.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pandas/core/generic.py b/pandas/core/generic.py index 0c9f801838986..b528510be359e 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -5349,7 +5349,7 @@ def get_values(self): Returns ------- numpy.ndarray - Numpy representation of DataFrame + Numpy representation of DataFrame. See Also -------- @@ -5428,7 +5428,7 @@ def get_ftype_counts(self): ------- dtype : Series Series with the count of columns with each type and - sparsity (dense/sparse) + sparsity (dense/sparse). See Also -------- From 8d4c6b456514c19dcd8a87cfc00f97b1725ed751 Mon Sep 17 00:00:00 2001 From: zangell44 <42625717+zangell44@users.noreply.github.com> Date: Wed, 13 Feb 2019 10:18:53 -0500 Subject: [PATCH 13/29] pandas plotting area and boxplot method return docstring updates --- pandas/core/generic.py | 6 +++--- pandas/plotting/_core.py | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/pandas/core/generic.py b/pandas/core/generic.py index b528510be359e..4cee631c3ab67 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -4950,9 +4950,9 @@ def pipe(self, func, *args, **kwargs): Returns ------- DataFrame, Series or scalar - If DataFrame.agg is called with a single function, returns a Series. - If DataFrame.agg is called with several functions, returns a DataFrame. - If Series.agg is called with single function, returns a scalar. + If DataFrame.agg is called with a single function, returns a Series + If DataFrame.agg is called with several functions, returns a DataFrame + If Series.agg is called with single function, returns a scalar If Series.agg is called with several functions, returns a Series. %(see_also)s diff --git a/pandas/plotting/_core.py b/pandas/plotting/_core.py index a525b9cff1182..09145abc1231d 100644 --- a/pandas/plotting/_core.py +++ b/pandas/plotting/_core.py @@ -2061,7 +2061,7 @@ def plot_series(data, kind='line', ax=None, # Series unique For data grouped with ``by``: * :class:`~pandas.Series` - * :class:`~numpy.array` (for ``return_type = None``) + * :class:`~numpy.array` (for ``return_type = None``). See Also -------- @@ -3332,7 +3332,7 @@ def area(self, x=None, y=None, **kwds): Returns ------- matplotlib.axes.Axes or numpy.ndarray - Area plot, or array of area plots if subplots is True + Area plot, or array of area plots if subplots is True. See Also -------- From a15ec00ee9c28da8c30a933497a02e654dc54022 Mon Sep 17 00:00:00 2001 From: zangell44 <42625717+zangell44@users.noreply.github.com> Date: Wed, 13 Feb 2019 10:21:54 -0500 Subject: [PATCH 14/29] pandas.Panel set_value major_xs minor_xs methods return docstring updated --- pandas/core/panel.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pandas/core/panel.py b/pandas/core/panel.py index dda5533f1ea7b..1555542079d80 100644 --- a/pandas/core/panel.py +++ b/pandas/core/panel.py @@ -540,7 +540,7 @@ def set_value(self, *args, **kwargs): ------- panel : Panel If label combo is contained, will be reference to calling Panel, - otherwise a new object + otherwise a new object. """ warnings.warn("set_value is deprecated and will be removed " "in a future release. Please use " @@ -803,7 +803,7 @@ def major_xs(self, key): Returns ------- y : DataFrame - Index -> minor axis, columns -> items + Index -> minor axis, columns -> items. Notes ----- @@ -827,7 +827,7 @@ def minor_xs(self, key): Returns ------- y : DataFrame - Index -> major axis, columns -> items + Index -> major axis, columns -> items. Notes ----- From 01a7b19beeb620f66ad0520860a60b6be6ef6188 Mon Sep 17 00:00:00 2001 From: zangell44 <42625717+zangell44@users.noreply.github.com> Date: Wed, 13 Feb 2019 10:24:01 -0500 Subject: [PATCH 15/29] pandas.Categorical.array return docstring update --- pandas/core/arrays/categorical.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pandas/core/arrays/categorical.py b/pandas/core/arrays/categorical.py index ab58f86e0a6bc..d7d0882bbcc94 100644 --- a/pandas/core/arrays/categorical.py +++ b/pandas/core/arrays/categorical.py @@ -1292,7 +1292,7 @@ def __array__(self, dtype=None): values : numpy array A numpy array of either the specified dtype or, if dtype==None (default), the same dtype as - categorical.categories.dtype + categorical.categories.dtype. """ ret = take_1d(self.categories.values, self._codes) if dtype and not is_dtype_equal(dtype, self.categories.dtype): From 998f649d672c388e8d3e5c5772e66dd1a839d356 Mon Sep 17 00:00:00 2001 From: zangell44 <42625717+zangell44@users.noreply.github.com> Date: Wed, 13 Feb 2019 10:25:30 -0500 Subject: [PATCH 16/29] pandas.unique return docstring update --- pandas/core/algorithms.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pandas/core/algorithms.py b/pandas/core/algorithms.py index 77681f6ac3f93..c5c8f47ad6dba 100644 --- a/pandas/core/algorithms.py +++ b/pandas/core/algorithms.py @@ -291,7 +291,7 @@ def unique(values): unique values. If the input is an Index, the return is an Index If the input is a Categorical dtype, the return is a Categorical - If the input is a Series/ndarray, the return will be an ndarray + If the input is a Series/ndarray, the return will be an ndarray. See Also -------- From 77bd88ef324ac6945c2e14db2560b110a1551a38 Mon Sep 17 00:00:00 2001 From: zangell44 <42625717+zangell44@users.noreply.github.com> Date: Wed, 13 Feb 2019 10:26:40 -0500 Subject: [PATCH 17/29] pandas.wide_to_long return docstring update --- pandas/core/reshape/melt.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pandas/core/reshape/melt.py b/pandas/core/reshape/melt.py index 312a108ad3380..0fa80de812c5f 100644 --- a/pandas/core/reshape/melt.py +++ b/pandas/core/reshape/melt.py @@ -230,7 +230,7 @@ def wide_to_long(df, stubnames, i, j, sep="", suffix=r'\d+'): ------- DataFrame A DataFrame that contains each stub name as a variable, with new index - (i, j) + (i, j). Notes ----- From b090af130d772e63b0f6cd75d68827d34d948f05 Mon Sep 17 00:00:00 2001 From: zangell44 <42625717+zangell44@users.noreply.github.com> Date: Wed, 13 Feb 2019 10:27:33 -0500 Subject: [PATCH 18/29] pandas.to_numeric return docstring update --- pandas/core/tools/numeric.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pandas/core/tools/numeric.py b/pandas/core/tools/numeric.py index b8a7eb5b0c570..08ce649d8602c 100644 --- a/pandas/core/tools/numeric.py +++ b/pandas/core/tools/numeric.py @@ -59,7 +59,7 @@ def to_numeric(arg, errors='raise', downcast=None): Returns ------- ret : numeric if parsing succeeded. - Return type depends on input. Series if Series, otherwise ndarray + Return type depends on input. Series if Series, otherwise ndarray. See Also -------- From 20adfcefd2cfda7e0c12a3300544f08820ab8cd6 Mon Sep 17 00:00:00 2001 From: zangell44 <42625717+zangell44@users.noreply.github.com> Date: Wed, 13 Feb 2019 10:31:09 -0500 Subject: [PATCH 19/29] pandas.core.window kurt return docstring updated --- pandas/core/window.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pandas/core/window.py b/pandas/core/window.py index fb37d790f950c..9e29fdb94c1e0 100644 --- a/pandas/core/window.py +++ b/pandas/core/window.py @@ -1271,7 +1271,7 @@ def skew(self, **kwargs): ------- Series or DataFrame Returned object type is determined by the caller of the %(name)s - calculation + calculation. See Also -------- From 0514c6f8cba51bb6b6a0406c767703e1c21385ad Mon Sep 17 00:00:00 2001 From: zangell44 <42625717+zangell44@users.noreply.github.com> Date: Wed, 13 Feb 2019 15:11:05 -0500 Subject: [PATCH 20/29] pandas.io.formats.style.Styler.render return docstring fix --- pandas/io/formats/style.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pandas/io/formats/style.py b/pandas/io/formats/style.py index cd6e3505d71db..c8b5dc6b9b7c0 100644 --- a/pandas/io/formats/style.py +++ b/pandas/io/formats/style.py @@ -435,7 +435,7 @@ def render(self, **kwargs): Returns ------- rendered : str - The rendered HTML + The rendered HTML. Notes ----- From 0038a7317fbb916d37214c5205623fd95f10ccf8 Mon Sep 17 00:00:00 2001 From: zangell44 <42625717+zangell44@users.noreply.github.com> Date: Wed, 13 Feb 2019 15:32:32 -0500 Subject: [PATCH 21/29] strftime return statement docstring fix --- pandas/core/arrays/datetimelike.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pandas/core/arrays/datetimelike.py b/pandas/core/arrays/datetimelike.py index 73e799f9e0a36..84536ac72a455 100644 --- a/pandas/core/arrays/datetimelike.py +++ b/pandas/core/arrays/datetimelike.py @@ -154,7 +154,7 @@ def strftime(self, date_format): Returns ------- Index - Index of formatted strings + Index of formatted strings. See Also -------- From 021ede44577495459531102c394a437e0b53bf03 Mon Sep 17 00:00:00 2001 From: zangell44 <42625717+zangell44@users.noreply.github.com> Date: Wed, 13 Feb 2019 15:34:00 -0500 Subject: [PATCH 22/29] series.set_value return statement docstring fix --- pandas/core/series.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pandas/core/series.py b/pandas/core/series.py index cf8301a948d53..94bafe0ceba66 100644 --- a/pandas/core/series.py +++ b/pandas/core/series.py @@ -1215,7 +1215,7 @@ def set_value(self, label, value, takeable=False): ------- Series If label is contained, will be reference to calling Series, - otherwise a new object + otherwise a new object. """ warnings.warn("set_value is deprecated and will be removed " "in a future release. Please use " From f3a5248c8e141fa883fc96e5764b948423c8b9d9 Mon Sep 17 00:00:00 2001 From: zangell44 <42625717+zangell44@users.noreply.github.com> Date: Wed, 13 Feb 2019 15:36:50 -0500 Subject: [PATCH 23/29] DataFrame.set_value return statement docstring fix --- pandas/core/frame.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pandas/core/frame.py b/pandas/core/frame.py index 85aa13526e77c..f7ea7f3657d6a 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -2743,7 +2743,7 @@ def set_value(self, index, col, value, takeable=False): ------- frame : DataFrame If label pair is contained, will be reference to calling DataFrame, - otherwise a new object + otherwise a new object. """ warnings.warn("set_value is deprecated and will be removed " "in a future release. Please use " From 421bab7d0e751069b735c0db41b7ce7060e6cd4e Mon Sep 17 00:00:00 2001 From: zangell44 <42625717+zangell44@users.noreply.github.com> Date: Thu, 14 Feb 2019 11:17:19 -0500 Subject: [PATCH 24/29] pandas.core.Series.unique return docstring update, moved extended description to Notes --- pandas/core/series.py | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/pandas/core/series.py b/pandas/core/series.py index 94bafe0ceba66..debaca60bb5a0 100644 --- a/pandas/core/series.py +++ b/pandas/core/series.py @@ -1648,10 +1648,19 @@ def unique(self): Returns ------- ndarray or ExtensionArray - The unique values returned as a NumPy array. In case of an - extension-array backed Series, a new - :class:`~api.extensions.ExtensionArray` of that type with just - the unique values is returned. This includes + The unique values returned as a NumPy array. See Notes. + + See Also + -------- + unique : Top-level unique method for any 1-d array-like object. + Index.unique : Return Index with unique values from an Index object. + + Notes + ----- + Returns the unique values as a NumPy array. In case of an + extension-array backed Series, a new + :class:`~api.extensions.ExtensionArray` of that type with just + the unique values is returned. This includes * Categorical * Period @@ -1660,11 +1669,6 @@ def unique(self): * Sparse * IntegerNA. - See Also - -------- - unique : Top-level unique method for any 1-d array-like object. - Index.unique : Return Index with unique values from an Index object. - Examples -------- >>> pd.Series([2, 1, 3, 3], name='A').unique() From 24b20a3cebcd4ced856bddc37086cba89df872bf Mon Sep 17 00:00:00 2001 From: zangell44 <42625717+zangell44@users.noreply.github.com> Date: Thu, 14 Feb 2019 11:20:40 -0500 Subject: [PATCH 25/29] pandas.plotting._core.box_plot return docstring udpated, extended return description moved to Notes section --- pandas/plotting/_core.py | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/pandas/plotting/_core.py b/pandas/plotting/_core.py index 09145abc1231d..631f694c36741 100644 --- a/pandas/plotting/_core.py +++ b/pandas/plotting/_core.py @@ -2051,8 +2051,16 @@ def plot_series(data, kind='line', ax=None, # Series unique Returns ------- result : + See Notes. - The return type depends on the `return_type` parameter: + See Also + -------- + Series.plot.hist: Make a histogram. + matplotlib.pyplot.boxplot : Matplotlib equivalent plot. + + Notes + ----- + The return type depends on the `return_type` parameter: * 'axes' : object of class matplotlib.axes.Axes * 'dict' : dict of matplotlib.lines.Line2D objects @@ -2063,13 +2071,6 @@ def plot_series(data, kind='line', ax=None, # Series unique * :class:`~pandas.Series` * :class:`~numpy.array` (for ``return_type = None``). - See Also - -------- - Series.plot.hist: Make a histogram. - matplotlib.pyplot.boxplot : Matplotlib equivalent plot. - - Notes - ----- Use ``return_type='dict'`` when you want to tweak the appearance of the lines after plotting. In this case a dict containing the Lines making up the boxes, caps, fliers, medians, and whiskers is returned. From ae876242044023bf6f72bab1e83089b6eb41aa0f Mon Sep 17 00:00:00 2001 From: zangell44 <42625717+zangell44@users.noreply.github.com> Date: Thu, 14 Feb 2019 11:40:16 -0500 Subject: [PATCH 26/29] code_checks.sh script updated to include RT05 errors in docstring --- ci/code_checks.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index eacab199cc0be..a6effc8a61302 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -241,7 +241,7 @@ fi ### DOCSTRINGS ### if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then - MSG='Validate docstrings (GL06, GL07, GL09, SS04, PR03, PR05, PR10, EX04, RT04, SS05, SA05)' ; echo $MSG + MSG='Validate docstrings (GL06, GL07, GL09, SS04, PR03, PR05, PR10, EX04, RT04, RT05, SS05, SA05)' ; echo $MSG $BASE_DIR/scripts/validate_docstrings.py --format=azure --errors=GL06,GL07,GL09,SS04,PR03,PR04,PR05,EX04,RT04,SS05,SA05 RET=$(($RET + $?)) ; echo $MSG "DONE" From 8b3d251fc9e1c56de836bf3a5785ade8e543d629 Mon Sep 17 00:00:00 2001 From: zangell44 <42625717+zangell44@users.noreply.github.com> Date: Thu, 14 Feb 2019 11:57:37 -0500 Subject: [PATCH 27/29] updated code check CI script to actually check for RT05 errors this time :) --- ci/code_checks.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index a6effc8a61302..ac6aade106ce6 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -242,7 +242,7 @@ fi if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then MSG='Validate docstrings (GL06, GL07, GL09, SS04, PR03, PR05, PR10, EX04, RT04, RT05, SS05, SA05)' ; echo $MSG - $BASE_DIR/scripts/validate_docstrings.py --format=azure --errors=GL06,GL07,GL09,SS04,PR03,PR04,PR05,EX04,RT04,SS05,SA05 + $BASE_DIR/scripts/validate_docstrings.py --format=azure --errors=GL06,GL07,GL09,SS04,PR03,PR04,PR05,EX04,RT04,RT05,SS05,SA05 RET=$(($RET + $?)) ; echo $MSG "DONE" fi From 6b3ed7b704732d103d6de706f1fa4937ecdab657 Mon Sep 17 00:00:00 2001 From: zangell44 <42625717+zangell44@users.noreply.github.com> Date: Thu, 14 Feb 2019 12:00:44 -0500 Subject: [PATCH 28/29] pandas.plotting._core.box_plot docstring minor formatting edits --- pandas/plotting/_core.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pandas/plotting/_core.py b/pandas/plotting/_core.py index 631f694c36741..2c672f235f1e1 100644 --- a/pandas/plotting/_core.py +++ b/pandas/plotting/_core.py @@ -2050,7 +2050,7 @@ def plot_series(data, kind='line', ax=None, # Series unique Returns ------- - result : + result See Notes. See Also @@ -2069,7 +2069,7 @@ def plot_series(data, kind='line', ax=None, # Series unique For data grouped with ``by``: * :class:`~pandas.Series` - * :class:`~numpy.array` (for ``return_type = None``). + * :class:`~numpy.array` (for ``return_type = None``) Use ``return_type='dict'`` when you want to tweak the appearance of the lines after plotting. In this case a dict containing the Lines From dd242ea7ef588286caf1429c735957f3f5cd42ab Mon Sep 17 00:00:00 2001 From: zangell44 <42625717+zangell44@users.noreply.github.com> Date: Thu, 14 Feb 2019 12:01:23 -0500 Subject: [PATCH 29/29] pandas.core.Series.unique trailing period removed from Notes portion of docstring --- pandas/core/series.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pandas/core/series.py b/pandas/core/series.py index debaca60bb5a0..31c6247436418 100644 --- a/pandas/core/series.py +++ b/pandas/core/series.py @@ -1667,7 +1667,7 @@ def unique(self): * Datetime with Timezone * Interval * Sparse - * IntegerNA. + * IntegerNA Examples --------