Skip to content

Commit

Permalink
DOC: fix RT03,SA01,ES01 for pandas.plotting.lag_plot (#59990)
Browse files Browse the repository at this point in the history
  • Loading branch information
tuhinsharma121 authored Oct 7, 2024
1 parent e5dc064 commit b3d0b96
Show file tree
Hide file tree
Showing 2 changed files with 11 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 @@ -178,7 +178,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.io.stata.StataWriter.write_file SA01" \
-i "pandas.json_normalize RT03,SA01" \
-i "pandas.plotting.andrews_curves RT03,SA01" \
-i "pandas.plotting.lag_plot RT03,SA01" \
-i "pandas.plotting.scatter_matrix PR07,SA01" \
-i "pandas.set_eng_float_format RT03,SA01" \
-i "pandas.tseries.offsets.BDay PR02,SA01" \
Expand Down
11 changes: 11 additions & 0 deletions pandas/plotting/_misc.py
Original file line number Diff line number Diff line change
Expand Up @@ -549,6 +549,10 @@ def lag_plot(series: Series, lag: int = 1, ax: Axes | None = None, **kwds) -> Ax
"""
Lag plot for time series.
A lag plot is a scatter plot of a time series against a lag of itself. It helps
in visualizing the temporal dependence between observations by plotting the values
at time `t` on the x-axis and the values at time `t + lag` on the y-axis.
Parameters
----------
series : Series
Expand All @@ -563,6 +567,13 @@ def lag_plot(series: Series, lag: int = 1, ax: Axes | None = None, **kwds) -> Ax
Returns
-------
matplotlib.axes.Axes
The matplotlib Axes object containing the lag plot.
See Also
--------
plotting.autocorrelation_plot : Autocorrelation plot for time series.
matplotlib.pyplot.scatter : A scatter plot of y vs. x with varying marker size
and/or color in Matplotlib.
Examples
--------
Expand Down

0 comments on commit b3d0b96

Please sign in to comment.