Skip to content

Commit 7e3ca31

Browse files
Josiah Bakerproost
Josiah Baker
authored andcommitted
DOC: fix PR09,PR08 docstring errors in pandas.plotting (pandas-dev#28689)
1 parent 5397cc3 commit 7e3ca31

File tree

1 file changed

+44
-47
lines changed

1 file changed

+44
-47
lines changed

pandas/plotting/_misc.py

+44-47
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ def table(ax, data, rowLabels=None, colLabels=None, **kwargs):
1414
----------
1515
ax : Matplotlib axes object
1616
data : DataFrame or Series
17-
data for table contents
18-
kwargs : keywords, optional
19-
keyword arguments which passed to matplotlib.table.table.
17+
Data for table contents.
18+
**kwargs
19+
Keyword arguments to be passed to matplotlib.table.table.
2020
If `rowLabels` or `colLabels` is not specified, data index or column
2121
name will be used.
2222
@@ -82,7 +82,7 @@ def scatter_matrix(
8282
density_kwds=None,
8383
hist_kwds=None,
8484
range_padding=0.05,
85-
**kwds
85+
**kwargs
8686
):
8787
"""
8888
Draw a matrix of scatter plots.
@@ -91,28 +91,26 @@ def scatter_matrix(
9191
----------
9292
frame : DataFrame
9393
alpha : float, optional
94-
amount of transparency applied
94+
Amount of transparency applied.
9595
figsize : (float,float), optional
96-
a tuple (width, height) in inches
96+
A tuple (width, height) in inches.
9797
ax : Matplotlib axis object, optional
9898
grid : bool, optional
99-
setting this to True will show the grid
99+
Setting this to True will show the grid.
100100
diagonal : {'hist', 'kde'}
101-
pick between 'kde' and 'hist' for
102-
either Kernel Density Estimation or Histogram
103-
plot in the diagonal
101+
Pick between 'kde' and 'hist' for either Kernel Density Estimation or
102+
Histogram plot in the diagonal.
104103
marker : str, optional
105-
Matplotlib marker type, default '.'
106-
hist_kwds : other plotting keyword arguments
107-
To be passed to hist function
108-
density_kwds : other plotting keyword arguments
109-
To be passed to kernel density estimate plot
110-
range_padding : float, optional
111-
relative extension of axis range in x and y
112-
with respect to (x_max - x_min) or (y_max - y_min),
113-
default 0.05
114-
kwds : other plotting keyword arguments
115-
To be passed to scatter function
104+
Matplotlib marker type, default '.'.
105+
density_kwds : keywords
106+
Keyword arguments to be passed to kernel density estimate plot.
107+
hist_kwds : keywords
108+
Keyword arguments to be passed to hist function.
109+
range_padding : float, default 0.05
110+
Relative extension of axis range in x and y with respect to
111+
(x_max - x_min) or (y_max - y_min).
112+
**kwargs
113+
Keyword arguments to be passed to scatter function.
116114
117115
Returns
118116
-------
@@ -136,7 +134,7 @@ def scatter_matrix(
136134
density_kwds=density_kwds,
137135
hist_kwds=hist_kwds,
138136
range_padding=range_padding,
139-
**kwds
137+
**kwargs
140138
)
141139

142140

@@ -215,7 +213,7 @@ def radviz(frame, class_column, ax=None, color=None, colormap=None, **kwds):
215213

216214
@deprecate_kwarg(old_arg_name="data", new_arg_name="frame")
217215
def andrews_curves(
218-
frame, class_column, ax=None, samples=200, color=None, colormap=None, **kwds
216+
frame, class_column, ax=None, samples=200, color=None, colormap=None, **kwargs
219217
):
220218
"""
221219
Generate a matplotlib plot of Andrews curves, for visualising clusters of
@@ -233,17 +231,17 @@ def andrews_curves(
233231
Parameters
234232
----------
235233
frame : DataFrame
236-
Data to be plotted, preferably normalized to (0.0, 1.0)
234+
Data to be plotted, preferably normalized to (0.0, 1.0).
237235
class_column : Name of the column containing class names
238236
ax : matplotlib axes object, default None
239237
samples : Number of points to plot in each curve
240238
color : list or tuple, optional
241-
Colors to use for the different classes
239+
Colors to use for the different classes.
242240
colormap : str or matplotlib colormap object, default None
243241
Colormap to select colors from. If string, load colormap with that name
244242
from matplotlib.
245-
kwds : keywords
246-
Options to pass to matplotlib plotting method
243+
**kwargs
244+
Options to pass to matplotlib plotting method.
247245
248246
Returns
249247
-------
@@ -257,7 +255,7 @@ def andrews_curves(
257255
samples=samples,
258256
color=color,
259257
colormap=colormap,
260-
**kwds
258+
**kwargs
261259
)
262260

263261

@@ -327,7 +325,7 @@ def parallel_coordinates(
327325
axvlines=True,
328326
axvlines_kwds=None,
329327
sort_labels=False,
330-
**kwds
328+
**kwargs
331329
):
332330
"""
333331
Parallel coordinates plotting.
@@ -336,30 +334,29 @@ def parallel_coordinates(
336334
----------
337335
frame : DataFrame
338336
class_column : str
339-
Column name containing class names
337+
Column name containing class names.
340338
cols : list, optional
341-
A list of column names to use
339+
A list of column names to use.
342340
ax : matplotlib.axis, optional
343-
matplotlib axis object
341+
Matplotlib axis object.
344342
color : list or tuple, optional
345-
Colors to use for the different classes
343+
Colors to use for the different classes.
346344
use_columns : bool, optional
347-
If true, columns will be used as xticks
345+
If true, columns will be used as xticks.
348346
xticks : list or tuple, optional
349-
A list of values to use for xticks
347+
A list of values to use for xticks.
350348
colormap : str or matplotlib colormap, default None
351349
Colormap to use for line colors.
352350
axvlines : bool, optional
353-
If true, vertical lines will be added at each xtick
351+
If true, vertical lines will be added at each xtick.
354352
axvlines_kwds : keywords, optional
355-
Options to be passed to axvline method for vertical lines
356-
sort_labels : bool, False
357-
Sort class_column labels, useful when assigning colors
353+
Options to be passed to axvline method for vertical lines.
354+
sort_labels : bool, default False
355+
Sort class_column labels, useful when assigning colors.
358356
359357
.. versionadded:: 0.20.0
360-
361-
kwds : keywords
362-
Options to pass to matplotlib plotting method
358+
**kwargs
359+
Options to pass to matplotlib plotting method.
363360
364361
Returns
365362
-------
@@ -388,7 +385,7 @@ def parallel_coordinates(
388385
axvlines=axvlines,
389386
axvlines_kwds=axvlines_kwds,
390387
sort_labels=sort_labels,
391-
**kwds
388+
**kwargs
392389
)
393390

394391

@@ -411,23 +408,23 @@ def lag_plot(series, lag=1, ax=None, **kwds):
411408
return plot_backend.lag_plot(series=series, lag=lag, ax=ax, **kwds)
412409

413410

414-
def autocorrelation_plot(series, ax=None, **kwds):
411+
def autocorrelation_plot(series, ax=None, **kwargs):
415412
"""
416413
Autocorrelation plot for time series.
417414
418415
Parameters
419416
----------
420417
series : Time series
421418
ax : Matplotlib axis object, optional
422-
kwds : keywords
423-
Options to pass to matplotlib plotting method
419+
**kwargs
420+
Options to pass to matplotlib plotting method.
424421
425422
Returns
426423
-------
427424
class:`matplotlib.axis.Axes`
428425
"""
429426
plot_backend = _get_plot_backend("matplotlib")
430-
return plot_backend.autocorrelation_plot(series=series, ax=ax, **kwds)
427+
return plot_backend.autocorrelation_plot(series=series, ax=ax, **kwargs)
431428

432429

433430
def tsplot(series, plotf, ax=None, **kwargs):

0 commit comments

Comments
 (0)