Skip to content

DOC: Fix docstring error SA01 for pandas.Dataframe.plot, pandas.Series.plot, pandas.core.groupby.DataFrameGroupBy.plot, pandas.core.groupby.SeriesGroupBy.plot #58842

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 31, 2024
Merged

DOC: Fix docstring error SA01 for pandas.Dataframe.plot, pandas.Series.plot, pandas.core.groupby.DataFrameGroupBy.plot, pandas.core.groupby.SeriesGroupBy.plot #58842

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
946bf5f
Updated See Also for pandas.Dataframe.plot - S01
anishfish2 May 27, 2024
e0c3f25
Updating pandas.Series.plot to pass SA01 docstring test
anishfish2 May 27, 2024
b94677a
Updating pandas.core.groupby.DataFrameGroupBy.plot to pass SA01 docst…
anishfish2 May 27, 2024
8aabaa0
Updating pandas.core.groupby.SeriesGroupBy.plot to pass SA01 docstrin…
anishfish2 May 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.DataFrame.mean RT03,SA01" \
-i "pandas.DataFrame.median RT03,SA01" \
-i "pandas.DataFrame.min RT03" \
-i "pandas.DataFrame.plot PR02,SA01" \
-i "pandas.DataFrame.plot PR02" \
-i "pandas.Grouper PR02" \
-i "pandas.MultiIndex PR01" \
-i "pandas.MultiIndex.append PR07,SA01" \
Expand Down Expand Up @@ -172,7 +172,7 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Series.lt SA01" \
-i "pandas.Series.ne SA01" \
-i "pandas.Series.pad PR01,SA01" \
-i "pandas.Series.plot PR02,SA01" \
-i "pandas.Series.plot PR02" \
-i "pandas.Series.pop RT03,SA01" \
-i "pandas.Series.prod RT03" \
-i "pandas.Series.product RT03" \
Expand Down Expand Up @@ -367,7 +367,7 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.core.groupby.DataFrameGroupBy.nth PR02" \
-i "pandas.core.groupby.DataFrameGroupBy.nunique SA01" \
-i "pandas.core.groupby.DataFrameGroupBy.ohlc SA01" \
-i "pandas.core.groupby.DataFrameGroupBy.plot PR02,SA01" \
-i "pandas.core.groupby.DataFrameGroupBy.plot PR02" \
-i "pandas.core.groupby.DataFrameGroupBy.prod SA01" \
-i "pandas.core.groupby.DataFrameGroupBy.sem SA01" \
-i "pandas.core.groupby.DataFrameGroupBy.sum SA01" \
Expand All @@ -385,7 +385,7 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.core.groupby.SeriesGroupBy.min SA01" \
-i "pandas.core.groupby.SeriesGroupBy.nth PR02" \
-i "pandas.core.groupby.SeriesGroupBy.ohlc SA01" \
-i "pandas.core.groupby.SeriesGroupBy.plot PR02,SA01" \
-i "pandas.core.groupby.SeriesGroupBy.plot PR02" \
-i "pandas.core.groupby.SeriesGroupBy.prod SA01" \
-i "pandas.core.groupby.SeriesGroupBy.sem SA01" \
-i "pandas.core.groupby.SeriesGroupBy.sum SA01" \
Expand Down
15 changes: 15 additions & 0 deletions pandas/plotting/_core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -791,6 +791,21 @@ class PlotAccessor(PandasObject):
If the backend is not the default matplotlib one, the return value
will be the object returned by the backend.

See Also
--------
matplotlib.pyplot.plot : Plot y versus x as lines and/or markers.
DataFrame.hist : Make a histogram.
DataFrame.boxplot : Make a box plot.
DataFrame.plot.scatter : Make a scatter plot with varying marker
point size and color.
DataFrame.plot.hexbin : Make a hexagonal binning plot of
two variables.
DataFrame.plot.kde : Make Kernel Density Estimate plot using
Gaussian kernels.
DataFrame.plot.area : Make a stacked area plot.
DataFrame.plot.bar : Make a bar plot.
DataFrame.plot.barh : Make a horizontal bar plot.

Notes
-----
- See matplotlib documentation online for more on this subject
Expand Down