From 5099d088e6245bf01bcf3f5a8de2d7045cfad862 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Israel=20Saeta=20P=C3=A9rez?= Date: Thu, 8 Mar 2018 15:04:19 +0100 Subject: [PATCH] DOC: Rewording additional kwargs for plot In the end, what the user needs to know is that the other keywords are documented in `pandas.Series.plot`. The fact that these plot help functions call `pandas.Series.plot` under the hood is an implementation detail. --- pandas/plotting/_core.py | 54 ++++++++++++++++++++++++++-------------- 1 file changed, 36 insertions(+), 18 deletions(-) diff --git a/pandas/plotting/_core.py b/pandas/plotting/_core.py index 44966e15b1e9a..520c6cecce6d7 100644 --- a/pandas/plotting/_core.py +++ b/pandas/plotting/_core.py @@ -2532,7 +2532,8 @@ def line(self, **kwds): Parameters ---------- `**kwds` : optional - Keyword arguments to pass on to :py:meth:`pandas.Series.plot`. + Additional keyword arguments are documented in + :meth:`pandas.Series.plot`. Returns ------- @@ -2556,7 +2557,8 @@ def bar(self, **kwds): Parameters ---------- `**kwds` : optional - Keyword arguments to pass on to :py:meth:`pandas.Series.plot`. + Additional keyword arguments are documented in + :meth:`pandas.Series.plot`. Returns ------- @@ -2571,7 +2573,8 @@ def barh(self, **kwds): Parameters ---------- `**kwds` : optional - Keyword arguments to pass on to :py:meth:`pandas.Series.plot`. + Additional keyword arguments are documented in + :meth:`pandas.Series.plot`. Returns ------- @@ -2586,7 +2589,8 @@ def box(self, **kwds): Parameters ---------- `**kwds` : optional - Keyword arguments to pass on to :py:meth:`pandas.Series.plot`. + Additional keyword arguments are documented in + :meth:`pandas.Series.plot`. Returns ------- @@ -2603,7 +2607,8 @@ def hist(self, bins=10, **kwds): bins: integer, default 10 Number of histogram bins to be used `**kwds` : optional - Keyword arguments to pass on to :py:meth:`pandas.Series.plot`. + Additional keyword arguments are documented in + :meth:`pandas.Series.plot`. Returns ------- @@ -2633,7 +2638,8 @@ def kde(self, bw_method=None, ind=None, **kwds): kde is evaluated at the points passed. If `ind` is an integer, `ind` number of equally spaced points are used. kwds : optional - Keyword arguments to pass on to :py:meth:`pandas.Series.plot`. + Additional keyword arguments are documented in + :meth:`pandas.Series.plot`. Returns ------- @@ -2692,7 +2698,8 @@ def area(self, **kwds): Parameters ---------- `**kwds` : optional - Keyword arguments to pass on to :py:meth:`pandas.Series.plot`. + Additional keyword arguments are documented in + :meth:`pandas.Series.plot`. Returns ------- @@ -2707,7 +2714,8 @@ def pie(self, **kwds): Parameters ---------- `**kwds` : optional - Keyword arguments to pass on to :py:meth:`pandas.Series.plot`. + Additional keyword arguments are documented in + :meth:`pandas.Series.plot`. Returns ------- @@ -2758,7 +2766,8 @@ def line(self, x=None, y=None, **kwds): x, y : label or position, optional Coordinates for each point. `**kwds` : optional - Keyword arguments to pass on to :py:meth:`pandas.DataFrame.plot`. + Additional keyword arguments are documented in + :meth:`pandas.DataFrame.plot`. Returns ------- @@ -2775,7 +2784,8 @@ def bar(self, x=None, y=None, **kwds): x, y : label or position, optional Coordinates for each point. `**kwds` : optional - Keyword arguments to pass on to :py:meth:`pandas.DataFrame.plot`. + Additional keyword arguments are documented in + :meth:`pandas.DataFrame.plot`. Returns ------- @@ -2792,7 +2802,8 @@ def barh(self, x=None, y=None, **kwds): x, y : label or position, optional Coordinates for each point. `**kwds` : optional - Keyword arguments to pass on to :py:meth:`pandas.DataFrame.plot`. + Additional keyword arguments are documented in + :meth:`pandas.DataFrame.plot`. Returns ------- @@ -2809,7 +2820,8 @@ def box(self, by=None, **kwds): by : string or sequence Column in the DataFrame to group by. `**kwds` : optional - Keyword arguments to pass on to :py:meth:`pandas.DataFrame.plot`. + Additional keyword arguments are documented in + :meth:`pandas.DataFrame.plot`. Returns ------- @@ -2828,7 +2840,8 @@ def hist(self, by=None, bins=10, **kwds): bins: integer, default 10 Number of histogram bins to be used `**kwds` : optional - Keyword arguments to pass on to :py:meth:`pandas.DataFrame.plot`. + Additional keyword arguments are documented in + :meth:`pandas.DataFrame.plot`. Returns ------- @@ -2853,7 +2866,8 @@ def kde(self, bw_method=None, ind=None, **kwds): points passed. If `ind` is an integer, `ind` number of equally spaced points are used. `**kwds` : optional - Keyword arguments to pass on to :py:meth:`pandas.DataFrame.plot`. + Additional keyword arguments are documented in + :meth:`pandas.DataFrame.plot`. Returns ------- @@ -2872,7 +2886,8 @@ def area(self, x=None, y=None, **kwds): x, y : label or position, optional Coordinates for each point. `**kwds` : optional - Keyword arguments to pass on to :py:meth:`pandas.DataFrame.plot`. + Additional keyword arguments are documented in + :meth:`pandas.DataFrame.plot`. Returns ------- @@ -2889,7 +2904,8 @@ def pie(self, y=None, **kwds): y : label or position, optional Column to plot. `**kwds` : optional - Keyword arguments to pass on to :py:meth:`pandas.DataFrame.plot`. + Additional keyword arguments are documented in + :meth:`pandas.DataFrame.plot`. Returns ------- @@ -2910,7 +2926,8 @@ def scatter(self, x, y, s=None, c=None, **kwds): c : label or position, optional Color of each point. `**kwds` : optional - Keyword arguments to pass on to :py:meth:`pandas.DataFrame.plot`. + Additional keyword arguments are documented in + :meth:`pandas.DataFrame.plot`. Returns ------- @@ -2935,7 +2952,8 @@ def hexbin(self, x, y, C=None, reduce_C_function=None, gridsize=None, gridsize : int, optional Number of bins. `**kwds` : optional - Keyword arguments to pass on to :py:meth:`pandas.DataFrame.plot`. + Additional keyword arguments are documented in + :meth:`pandas.DataFrame.plot`. Returns -------