Skip to content
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

Jump to bottom

DOC: added see also to docstrings in mean and median #58951

Merged
merged 3 commits into from
Jun 10, 2024
Merged

DOC: added see also to docstrings in mean and median #58951

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5d9408e
added see also to docstrings
BDixon808 May 26, 2024
e795f20
fixed typing
BDixon808 Jun 8, 2024
5285228
Updated code check
BDixon808 Jun 10, 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
4 changes: 2 additions & 2 deletions ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,8 @@ 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.Grouper PR02" \
Expand Down
5 changes: 3 additions & 2 deletions pandas/core/generic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12571,7 +12571,7 @@ 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 = _stat_func_see_also
examples = """

Examples
Expand Down Expand Up @@ -12612,7 +12612,7 @@ 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 = _stat_func_see_also
examples = """

Examples
Expand Down Expand Up @@ -12760,6 +12760,7 @@ def make_doc(name: str, ndim: int) -> str:
a 0.0
dtype: float64"""
kwargs = {"min_count": ""}

elif name == "kurt":
base_doc = _num_doc
desc = (
Expand Down