Skip to content

Commit 79f4c53

Browse files
authored
DOC: Fix docstring error SA01 for pandas.Dataframe.plot, pandas.Series.plot, pandas.core.groupby.DataFrameGroupBy.plot, pandas.core.groupby.SeriesGroupBy.plot (#58842)
* Updated See Also for pandas.Dataframe.plot - S01 * Updating pandas.Series.plot to pass SA01 docstring test * Updating pandas.core.groupby.DataFrameGroupBy.plot to pass SA01 docstring test * Updating pandas.core.groupby.SeriesGroupBy.plot to pass SA01 docstring test
1 parent 8dc5a3f commit 79f4c53

File tree

2 files changed

+19
-4
lines changed

2 files changed

+19
-4
lines changed

ci/code_checks.sh

+4-4
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
7474
-i "pandas.DataFrame.mean RT03,SA01" \
7575
-i "pandas.DataFrame.median RT03,SA01" \
7676
-i "pandas.DataFrame.min RT03" \
77-
-i "pandas.DataFrame.plot PR02,SA01" \
77+
-i "pandas.DataFrame.plot PR02" \
7878
-i "pandas.Grouper PR02" \
7979
-i "pandas.MultiIndex.append PR07,SA01" \
8080
-i "pandas.MultiIndex.copy PR07,RT03,SA01" \
@@ -165,7 +165,7 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
165165
-i "pandas.Series.lt SA01" \
166166
-i "pandas.Series.ne SA01" \
167167
-i "pandas.Series.pad PR01,SA01" \
168-
-i "pandas.Series.plot PR02,SA01" \
168+
-i "pandas.Series.plot PR02" \
169169
-i "pandas.Series.pop RT03,SA01" \
170170
-i "pandas.Series.prod RT03" \
171171
-i "pandas.Series.product RT03" \
@@ -360,7 +360,7 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
360360
-i "pandas.core.groupby.DataFrameGroupBy.nth PR02" \
361361
-i "pandas.core.groupby.DataFrameGroupBy.nunique SA01" \
362362
-i "pandas.core.groupby.DataFrameGroupBy.ohlc SA01" \
363-
-i "pandas.core.groupby.DataFrameGroupBy.plot PR02,SA01" \
363+
-i "pandas.core.groupby.DataFrameGroupBy.plot PR02" \
364364
-i "pandas.core.groupby.DataFrameGroupBy.prod SA01" \
365365
-i "pandas.core.groupby.DataFrameGroupBy.sem SA01" \
366366
-i "pandas.core.groupby.DataFrameGroupBy.sum SA01" \
@@ -378,7 +378,7 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
378378
-i "pandas.core.groupby.SeriesGroupBy.min SA01" \
379379
-i "pandas.core.groupby.SeriesGroupBy.nth PR02" \
380380
-i "pandas.core.groupby.SeriesGroupBy.ohlc SA01" \
381-
-i "pandas.core.groupby.SeriesGroupBy.plot PR02,SA01" \
381+
-i "pandas.core.groupby.SeriesGroupBy.plot PR02" \
382382
-i "pandas.core.groupby.SeriesGroupBy.prod SA01" \
383383
-i "pandas.core.groupby.SeriesGroupBy.sem SA01" \
384384
-i "pandas.core.groupby.SeriesGroupBy.sum SA01" \

pandas/plotting/_core.py

+15
Original file line numberDiff line numberDiff line change
@@ -791,6 +791,21 @@ class PlotAccessor(PandasObject):
791791
If the backend is not the default matplotlib one, the return value
792792
will be the object returned by the backend.
793793
794+
See Also
795+
--------
796+
matplotlib.pyplot.plot : Plot y versus x as lines and/or markers.
797+
DataFrame.hist : Make a histogram.
798+
DataFrame.boxplot : Make a box plot.
799+
DataFrame.plot.scatter : Make a scatter plot with varying marker
800+
point size and color.
801+
DataFrame.plot.hexbin : Make a hexagonal binning plot of
802+
two variables.
803+
DataFrame.plot.kde : Make Kernel Density Estimate plot using
804+
Gaussian kernels.
805+
DataFrame.plot.area : Make a stacked area plot.
806+
DataFrame.plot.bar : Make a bar plot.
807+
DataFrame.plot.barh : Make a horizontal bar plot.
808+
794809
Notes
795810
-----
796811
- See matplotlib documentation online for more on this subject

0 commit comments

Comments
 (0)