Skip to content

Commit 241e0f5

Browse files
committed
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.
1 parent ad3cf39 commit 241e0f5

File tree

1 file changed

+34
-17
lines changed

1 file changed

+34
-17
lines changed

Diff for: pandas/plotting/_core.py

+34-17
Original file line numberDiff line numberDiff line change
@@ -2532,7 +2532,8 @@ def line(self, **kwds):
25322532
Parameters
25332533
----------
25342534
`**kwds` : optional
2535-
Keyword arguments to pass on to :py:meth:`pandas.Series.plot`.
2535+
Additional keyword arguments are documented in
2536+
:py:meth:`pandas.Series.plot`.
25362537
25372538
Returns
25382539
-------
@@ -2556,7 +2557,8 @@ def bar(self, **kwds):
25562557
Parameters
25572558
----------
25582559
`**kwds` : optional
2559-
Keyword arguments to pass on to :py:meth:`pandas.Series.plot`.
2560+
Additional keyword arguments are documented in
2561+
:py:meth:`pandas.Series.plot`.
25602562
25612563
Returns
25622564
-------
@@ -2571,7 +2573,8 @@ def barh(self, **kwds):
25712573
Parameters
25722574
----------
25732575
`**kwds` : optional
2574-
Keyword arguments to pass on to :py:meth:`pandas.Series.plot`.
2576+
Additional keyword arguments are documented in
2577+
:py:meth:`pandas.Series.plot`.
25752578
25762579
Returns
25772580
-------
@@ -2586,7 +2589,8 @@ def box(self, **kwds):
25862589
Parameters
25872590
----------
25882591
`**kwds` : optional
2589-
Keyword arguments to pass on to :py:meth:`pandas.Series.plot`.
2592+
Additional keyword arguments are documented in
2593+
:py:meth:`pandas.Series.plot`.
25902594
25912595
Returns
25922596
-------
@@ -2603,7 +2607,8 @@ def hist(self, bins=10, **kwds):
26032607
bins: integer, default 10
26042608
Number of histogram bins to be used
26052609
`**kwds` : optional
2606-
Keyword arguments to pass on to :py:meth:`pandas.Series.plot`.
2610+
Additional keyword arguments are documented in
2611+
:py:meth:`pandas.Series.plot`.
26072612
26082613
Returns
26092614
-------
@@ -2633,7 +2638,8 @@ def kde(self, bw_method=None, ind=None, **kwds):
26332638
kde is evaluated at the points passed. If `ind` is an integer,
26342639
`ind` number of equally spaced points are used.
26352640
kwds : optional
2636-
Keyword arguments to pass on to :py:meth:`pandas.Series.plot`.
2641+
Additional keyword arguments are documented in
2642+
:py:meth:`pandas.Series.plot`.
26372643
26382644
Returns
26392645
-------
@@ -2692,7 +2698,8 @@ def area(self, **kwds):
26922698
Parameters
26932699
----------
26942700
`**kwds` : optional
2695-
Keyword arguments to pass on to :py:meth:`pandas.Series.plot`.
2701+
Additional keyword arguments are documented in
2702+
:py:meth:`pandas.Series.plot`.
26962703
26972704
Returns
26982705
-------
@@ -2707,7 +2714,8 @@ def pie(self, **kwds):
27072714
Parameters
27082715
----------
27092716
`**kwds` : optional
2710-
Keyword arguments to pass on to :py:meth:`pandas.Series.plot`.
2717+
Additional keyword arguments are documented in
2718+
:py:meth:`pandas.Series.plot`.
27112719
27122720
Returns
27132721
-------
@@ -2758,7 +2766,8 @@ def line(self, x=None, y=None, **kwds):
27582766
x, y : label or position, optional
27592767
Coordinates for each point.
27602768
`**kwds` : optional
2761-
Keyword arguments to pass on to :py:meth:`pandas.DataFrame.plot`.
2769+
Additional keyword arguments are documented in
2770+
:py:meth:`pandas.DataFrame.plot`.
27622771
27632772
Returns
27642773
-------
@@ -2775,7 +2784,8 @@ def bar(self, x=None, y=None, **kwds):
27752784
x, y : label or position, optional
27762785
Coordinates for each point.
27772786
`**kwds` : optional
2778-
Keyword arguments to pass on to :py:meth:`pandas.DataFrame.plot`.
2787+
Additional keyword arguments are documented in
2788+
:py:meth:`pandas.DataFrame.plot`.
27792789
27802790
Returns
27812791
-------
@@ -2792,7 +2802,8 @@ def barh(self, x=None, y=None, **kwds):
27922802
x, y : label or position, optional
27932803
Coordinates for each point.
27942804
`**kwds` : optional
2795-
Keyword arguments to pass on to :py:meth:`pandas.DataFrame.plot`.
2805+
Additional keyword arguments are documented in
2806+
:py:meth:`pandas.DataFrame.plot`.
27962807
27972808
Returns
27982809
-------
@@ -2809,7 +2820,8 @@ def box(self, by=None, **kwds):
28092820
by : string or sequence
28102821
Column in the DataFrame to group by.
28112822
`**kwds` : optional
2812-
Keyword arguments to pass on to :py:meth:`pandas.DataFrame.plot`.
2823+
Additional keyword arguments are documented in
2824+
:py:meth:`pandas.DataFrame.plot`.
28132825
28142826
Returns
28152827
-------
@@ -2828,7 +2840,8 @@ def hist(self, by=None, bins=10, **kwds):
28282840
bins: integer, default 10
28292841
Number of histogram bins to be used
28302842
`**kwds` : optional
2831-
Keyword arguments to pass on to :py:meth:`pandas.DataFrame.plot`.
2843+
Additional keyword arguments are documented in
2844+
:py:meth:`pandas.DataFrame.plot`.
28322845
28332846
Returns
28342847
-------
@@ -2853,7 +2866,8 @@ def kde(self, bw_method=None, ind=None, **kwds):
28532866
points passed. If `ind` is an integer, `ind` number of equally
28542867
spaced points are used.
28552868
`**kwds` : optional
2856-
Keyword arguments to pass on to :py:meth:`pandas.DataFrame.plot`.
2869+
Additional keyword arguments are documented in
2870+
:py:meth:`pandas.DataFrame.plot`.
28572871
28582872
Returns
28592873
-------
@@ -2872,7 +2886,8 @@ def area(self, x=None, y=None, **kwds):
28722886
x, y : label or position, optional
28732887
Coordinates for each point.
28742888
`**kwds` : optional
2875-
Keyword arguments to pass on to :py:meth:`pandas.DataFrame.plot`.
2889+
Additional keyword arguments are documented in
2890+
:py:meth:`pandas.DataFrame.plot`.
28762891
28772892
Returns
28782893
-------
@@ -2889,7 +2904,8 @@ def pie(self, y=None, **kwds):
28892904
y : label or position, optional
28902905
Column to plot.
28912906
`**kwds` : optional
2892-
Keyword arguments to pass on to :py:meth:`pandas.DataFrame.plot`.
2907+
Additional keyword arguments are documented in
2908+
:py:meth:`pandas.DataFrame.plot`.
28932909
28942910
Returns
28952911
-------
@@ -2910,7 +2926,8 @@ def scatter(self, x, y, s=None, c=None, **kwds):
29102926
c : label or position, optional
29112927
Color of each point.
29122928
`**kwds` : optional
2913-
Keyword arguments to pass on to :py:meth:`pandas.DataFrame.plot`.
2929+
Additional keyword arguments are documented in
2930+
:py:meth:`pandas.DataFrame.plot`.
29142931
29152932
Returns
29162933
-------

0 commit comments

Comments
 (0)