Skip to content

Commit

Permalink
DOC: Rewording additional kwargs for plot
Browse files Browse the repository at this point in the history 
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.
  • Loading branch information
@dukebody
dukebody committed Mar 8, 2018
1 parent ad3cf39 commit 5099d08
Showing 1 changed file with 36 additions and 18 deletions.
54 changes: 36 additions & 18 deletions pandas/plotting/_core.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
-------
Expand All @@ -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
-------
Expand All @@ -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
-------
Expand All @@ -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
-------
Expand All @@ -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
-------
Expand Down Expand Up @@ -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
-------
Expand Down Expand Up @@ -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
-------
Expand All @@ -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
-------
Expand Down Expand Up @@ -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
-------
Expand All @@ -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
-------
Expand All @@ -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
-------
Expand All @@ -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
-------
Expand All @@ -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
-------
Expand All @@ -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
-------
Expand All @@ -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
-------
Expand All @@ -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
-------
Expand All @@ -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
-------
Expand All @@ -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
-------
Expand Down

0 comments on commit 5099d08

Please sign in to comment.