Skip to content

DOC: Enforce Numpy Docstring Validation for DataFrame #58362

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

Closed
wants to merge 9 commits into from
Closed

DOC: Enforce Numpy Docstring Validation for DataFrame #58362

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
4faf666
fix SA01 for mean and median DataFrame
gboeker Apr 21, 2024
a59e309
add mean and median see also
gboeker Apr 21, 2024
ef7a23c
fix SA01 issues for DataFrame.plot
gboeker Apr 21, 2024
b684c3e
fix SA01 erros for DataFrame.pop
gboeker Apr 21, 2024
602add4
fix docstring errors
gboeker Apr 21, 2024
0562d2a
Merge branch 'main' into docstring
gboeker Apr 23, 2024
21f88b5
Merge branch 'main' into docstring
gboeker Apr 24, 2024
f2b704f
Merge branch 'main' into docstring
gboeker May 5, 2024
da543c2
add empty line before see also
gboeker May 5, 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
14 changes: 7 additions & 7 deletions ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,10 +71,10 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i ES01 `# For now it is ok if docstrings are missing the extended summary` \
-i "pandas.Series.dt PR01" `# Accessors are implemented as classes, but we do not document the Parameters section` \
-i "pandas.DataFrame.max RT03" \
-i "pandas.DataFrame.mean RT03,SA01" \
-i "pandas.DataFrame.median RT03,SA01" \
-i "pandas.DataFrame.mean RT03" \
-i "pandas.DataFrame.median RT03" \
-i "pandas.DataFrame.min RT03" \
-i "pandas.DataFrame.plot PR02,SA01" \
-i "pandas.DataFrame.plot PR02" \
-i "pandas.DataFrame.std PR01,RT03,SA01" \
-i "pandas.DataFrame.sum RT03" \
-i "pandas.DataFrame.swaplevel SA01" \
Expand Down Expand Up @@ -206,14 +206,14 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Series.list.flatten SA01" \
-i "pandas.Series.list.len SA01" \
-i "pandas.Series.lt PR07,SA01" \
-i "pandas.Series.mean RT03,SA01" \
-i "pandas.Series.mean RT03" \
-i "pandas.Series.min RT03" \
-i "pandas.Series.mod PR07" \
-i "pandas.Series.mode SA01" \
-i "pandas.Series.mul PR07" \
-i "pandas.Series.ne PR07,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.pow PR07" \
-i "pandas.Series.prod RT03" \
Expand Down Expand Up @@ -462,7 +462,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 @@ -480,7 +480,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
13 changes: 11 additions & 2 deletions pandas/core/generic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12558,7 +12558,11 @@ def make_doc(name: str, ndim: int) -> str:
elif name == "median":
base_doc = _num_doc
desc = "Return the median of the values over the requested axis."
see_also = ""
see_also = """

See Also
--------
DataFrame.mean : Return the mean of the values over the requested axis."""
examples = """

Examples
Expand Down Expand Up @@ -12599,7 +12603,12 @@ def make_doc(name: str, ndim: int) -> str:
elif name == "mean":
base_doc = _num_doc
desc = "Return the mean of the values over the requested axis."
see_also = ""
see_also = """

See Also
--------
DataFrame.median : Return the median of the values over the requested
axis."""
examples = """

Examples
Expand Down
5 changes: 5 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,11 @@ 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
--------
DataFrame.plot.area : Draw a stacked area plot. An area plot displays quantitative
data visually. This function wraps the matplotlib area function.

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