Skip to content

Commit b3d0b96

Browse files
DOC: fix RT03,SA01,ES01 for pandas.plotting.lag_plot (#59990)
1 parent e5dc064 commit b3d0b96

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

ci/code_checks.sh

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
178178
-i "pandas.io.stata.StataWriter.write_file SA01" \
179179
-i "pandas.json_normalize RT03,SA01" \
180180
-i "pandas.plotting.andrews_curves RT03,SA01" \
181-
-i "pandas.plotting.lag_plot RT03,SA01" \
182181
-i "pandas.plotting.scatter_matrix PR07,SA01" \
183182
-i "pandas.set_eng_float_format RT03,SA01" \
184183
-i "pandas.tseries.offsets.BDay PR02,SA01" \

pandas/plotting/_misc.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -549,6 +549,10 @@ def lag_plot(series: Series, lag: int = 1, ax: Axes | None = None, **kwds) -> Ax
549549
"""
550550
Lag plot for time series.
551551
552+
A lag plot is a scatter plot of a time series against a lag of itself. It helps
553+
in visualizing the temporal dependence between observations by plotting the values
554+
at time `t` on the x-axis and the values at time `t + lag` on the y-axis.
555+
552556
Parameters
553557
----------
554558
series : Series
@@ -563,6 +567,13 @@ def lag_plot(series: Series, lag: int = 1, ax: Axes | None = None, **kwds) -> Ax
563567
Returns
564568
-------
565569
matplotlib.axes.Axes
570+
The matplotlib Axes object containing the lag plot.
571+
572+
See Also
573+
--------
574+
plotting.autocorrelation_plot : Autocorrelation plot for time series.
575+
matplotlib.pyplot.scatter : A scatter plot of y vs. x with varying marker size
576+
and/or color in Matplotlib.
566577
567578
Examples
568579
--------

0 commit comments

Comments
 (0)