Skip to content

Commit

Permalink
DOC: fix PR07,SA01,ES01 for pandas.plotting.scatter_matrix (#60572)
Browse files Browse the repository at this point in the history
  • Loading branch information
tuhinsharma121 authored Dec 16, 2024
1 parent 8e119a7 commit 43ed81f
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 1 deletion.
1 change: 0 additions & 1 deletion ci/code_checks.sh
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.errors.ValueLabelTypeMismatch SA01" \
-i "pandas.io.json.build_table_schema PR07,RT03,SA01" \
-i "pandas.plotting.andrews_curves RT03,SA01" \
-i "pandas.plotting.scatter_matrix PR07,SA01" \
-i "pandas.tseries.offsets.BDay PR02,SA01" \
-i "pandas.tseries.offsets.BQuarterBegin.is_on_offset GL08" \
-i "pandas.tseries.offsets.BQuarterBegin.n GL08" \
Expand Down
15 changes: 15 additions & 0 deletions pandas/plotting/_misc.py
Original file line number Diff line number Diff line change
Expand Up @@ -178,14 +178,21 @@ def scatter_matrix(
"""
Draw a matrix of scatter plots.
Each pair of numeric columns in the DataFrame is plotted against each other,
resulting in a matrix of scatter plots. The diagonal plots can display either
histograms or Kernel Density Estimation (KDE) plots for each variable.
Parameters
----------
frame : DataFrame
The data to be plotted.
alpha : float, optional
Amount of transparency applied.
figsize : (float,float), optional
A tuple (width, height) in inches.
ax : Matplotlib axis object, optional
An existing Matplotlib axis object for the plots. If None, a new axis is
created.
grid : bool, optional
Setting this to True will show the grid.
diagonal : {'hist', 'kde'}
Expand All @@ -208,6 +215,14 @@ def scatter_matrix(
numpy.ndarray
A matrix of scatter plots.
See Also
--------
plotting.parallel_coordinates : Plots parallel coordinates for multivariate data.
plotting.andrews_curves : Generates Andrews curves for visualizing clusters of
multivariate data.
plotting.radviz : Creates a RadViz visualization.
plotting.bootstrap_plot : Visualizes uncertainty in data via bootstrap sampling.
Examples
--------
Expand Down

0 comments on commit 43ed81f

Please sign in to comment.